daigaku 0.3.0 → 0.4.0

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)
@@ -86,8 +85,8 @@ 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
 
@@ -100,7 +99,6 @@ module Daigaku
       def downcased?(text)
         text == text.downcase
       end
-
     end
   end
 end

data/lib/daigaku/solution.rb

@@ -1,20 +1,19 @@
 module Daigaku
   class Solution
-
-    FILE_SUFFIX = '_solution.rb'
+    FILE_SUFFIX = '_solution.rb'.freeze
 
     attr_reader :code, :path, :errors
 
     def initialize(unit_path)
       @unit_path = unit_path
-      @path = solution_path(unit_path)
-      @code = File.read(@path).strip if File.file?(@path)
-      @verified = get_store_state
+      @path      = solution_path(unit_path)
+      @code      = File.read(@path).strip if File.file?(@path)
+      @verified  = store_state
     end
 
     def verify!
-      result = Daigaku::Test.new(@unit_path).run(self.code)
-      set_store_state(result.passed?)
+      result = Daigaku::Test.new(@unit_path).run(code)
+      self.store_state = result.passed?
       result
     end
 
@@ -24,7 +23,7 @@ module Daigaku
 
     def store_key
       unless @store_key
-        part_path = path.split('/')[-3..-1].join('/').gsub(FILE_SUFFIX, '')
+        part_path  = path.split('/')[-3..-1].join('/').gsub(FILE_SUFFIX, '')
         @store_key = Storeable.key(part_path, prefix: 'verified')
       end
 
@@ -34,20 +33,24 @@ module Daigaku
     private
 
     def solution_path(path)
-      local_path = Daigaku.config.solutions_path
-      sub_dirs = Storeable.key(path.split('/')[-3..-2].join('/').gsub(FILE_SUFFIX, ''))
-      file = Storeable.key(File.basename(path)) + FILE_SUFFIX
+      local_path    = Daigaku.config.solutions_path
+      sub_directory = Storeable.key(directory_from(path))
+      file          = Storeable.key(File.basename(path)) + FILE_SUFFIX
+
+      File.join(local_path, sub_directory, file)
+    end
 
-      File.join(local_path, sub_dirs, file)
+    def directory_from(path)
+      path.split('/')[-3..-2].join('/').gsub(FILE_SUFFIX, '')
     end
 
-    def set_store_state(verified)
+    def store_state=(verified)
       @verified = verified
       QuickStore.store.set(store_key, verified?)
     end
 
-    def get_store_state
+    def store_state
       QuickStore.store.get(store_key)
     end
   end
-end
+end

data/lib/daigaku/storeable.rb

@@ -1,15 +1,14 @@
 module Daigaku
   module Storeable
-
     LEADING_NUMBERS = /^\d+[\_\-\s]+/
-    PART_JOINTS = /[\_\-\s]+/
+    PART_JOINTS     = /[\_\-\s]+/
 
     class << self
       def key(text, options = {})
-        separator = QuickStore.config.key_separator
-        prefix = options[:prefix]
-        suffix = clean(options[:suffix])
-        suffixes = options[:suffixes]
+        separator      = QuickStore.config.key_separator
+        prefix         = options[:prefix]
+        suffix         = clean(options[:suffix])
+        suffixes       = options[:suffixes]
         suffixes_items = suffixes ? suffixes.map { |s| clean(s) }.compact : nil
 
         [prefix, clean(text), suffix || suffixes_items].compact.join(separator)
@@ -18,15 +17,15 @@ module Daigaku
       private
 
       def clean(text)
-        if text
-          parts = text.to_s.split(QuickStore.config.key_separator).map do |key|
-            key.gsub(LEADING_NUMBERS, '').gsub(PART_JOINTS, '_').downcase
-          end
+        return if text.nil?
+        parts(text.to_s).join(QuickStore.config.key_separator)
+      end
 
-          parts.join(QuickStore.config.key_separator)
+      def parts(text)
+        text.split(QuickStore.config.key_separator).map do |key|
+          key.gsub(LEADING_NUMBERS, '').gsub(PART_JOINTS, '_').downcase
         end
       end
     end
-
   end
 end

data/lib/daigaku/task.rb

@@ -3,7 +3,7 @@ module Daigaku
     attr_reader :markdown, :path
 
     def initialize(path)
-      @path = Dir[File.join(path, '*.md')].first
+      @path     = Dir[File.join(path, '*.md')].first
       @markdown = File.read(@path).strip
     end
   end

data/lib/daigaku/terminal.rb

@@ -1,12 +1,11 @@
 module Daigaku
   module Terminal
-
     # text should be of a width of 70 columns or less
     def self.text(file_name)
       texts_path = File.expand_path('../terminal/texts', __FILE__)
-      file = File.join(texts_path, "#{file_name.to_s}.txt")
-      (File.exist?(file) ? File.read(file).to_s : '')
-    end
+      file       = File.join(texts_path, "#{file_name}.txt")
 
+      File.exist?(file) ? File.read(file).to_s : ''
+    end
   end
 end

data/lib/daigaku/terminal/cli.rb

@@ -1,13 +1,11 @@
 require 'thor'
+require_relative 'courses'
+require_relative 'solutions'
+require_relative 'setup'
+require_relative 'output'
 
 module Daigaku
   module Terminal
-
-    require_relative 'courses'
-    require_relative 'solutions'
-    require_relative 'setup'
-    require_relative 'output'
-
     class CLI < Thor
       include Terminal::Output
 
@@ -21,7 +19,7 @@ module Daigaku
       subcommand 'setup', Terminal::Setup
 
       def self.start
-        Daigaku.config.import!
+        Daigaku.config.import
         super
       end
 
@@ -40,7 +38,7 @@ module Daigaku
         generator = Generator.new
         generator.prepare
 
-        courses_path = Daigaku.config.courses_path
+        courses_path   = Daigaku.config.courses_path
         solutions_path = Daigaku.config.solutions_path
 
         generator.scaffold(courses_path, solutions_path)

data/lib/daigaku/terminal/courses.rb

@@ -1,14 +1,18 @@
+require 'os'
+require 'open-uri'
+require 'zip'
+require_relative 'output'
+
 module Daigaku
   module Terminal
-
-    require 'os'
-    require 'open-uri'
-    require 'zip'
-    require_relative 'output'
-
     class Courses < Thor
       include Terminal::Output
 
+      GITHUB         = /github\.com/
+      MASTER_ZIP_URL = %r{github.com\/(.*)\/archive\/master.zip}
+      URL            = /\A#{URI.regexp(%w(http https))}\z/
+      ZIP_FILE       = /\.zip/
+
       desc 'list', 'List your available daigaku courses'
       def list
         courses = Loading::Courses.load(Daigaku.config.courses_path)
@@ -22,11 +26,11 @@ module Daigaku
         url = GithubClient.master_zip_url(Daigaku.config.initial_course) if use_initial_course
         url = GithubClient.master_zip_url(options[:github]) if options[:github]
 
-        url_given = (url =~ /\A#{URI::regexp(['http', 'https'])}\z/)
-        github = use_initial_course || options[:github] || url.match(/github\.com/)
+        url_given = (url =~ URL)
+        github = use_initial_course || options[:github] || url.match(GITHUB)
 
         raise Download::NoUrlError unless url_given
-        raise Download::NoZipFileUrlError unless File.basename(url) =~ /\.zip/
+        raise Download::NoZipFileUrlError unless File.basename(url) =~ ZIP_FILE
 
         courses_path = Daigaku.config.courses_path
         FileUtils.makedirs(courses_path) unless Dir.exist?(courses_path)
@@ -37,7 +41,7 @@ module Daigaku
         course = Course.unzip(file_name, github_repo: github)
 
         if github
-          user_and_repo = url.match(/github.com\/(.*)\/archive\/master.zip/).captures.first
+          user_and_repo = url.match(MASTER_ZIP_URL).captures.first
           store_repo_data(options[:github] || user_and_repo)
         end
 
@@ -46,11 +50,11 @@ module Daigaku
         scaffold_solutions
 
         say_info "Successfully #{action} the course \"#{course.title}\"!"
-      rescue Download::NoUrlError => e
+      rescue Download::NoUrlError
         print_download_warning(url, "\"#{url}\" is not a valid URL!")
-      rescue Download::NoZipFileUrlError => e
+      rescue Download::NoZipFileUrlError
         print_download_warning(url, "\"#{url}\" is not a URL of a *.zip file!")
-      rescue Exception => e
+      rescue StandardError => e
         print_download_warning(url, e.message)
       ensure
         FileUtils.rm(file_name) if File.exist?(file_name.to_s)
@@ -124,7 +128,7 @@ module Daigaku
       end
 
       def store_repo_data(user_and_repo)
-        parts = (user_and_repo ||= Daigaku.config.initial_course).split('/')
+        parts  = (user_and_repo ||= Daigaku.config.initial_course).split('/')
         author = parts.first
         course = parts.second
 
@@ -164,7 +168,7 @@ module Daigaku
       def print_course_not_available(course_name)
         text = [
           "The course \"#{course_name}\" is not available in",
-          "\"#{Daigaku.config.courses_path}\".\n",
+          "\"#{Daigaku.config.courses_path}\".\n"
         ]
 
         say_warning text.join("\n")
@@ -174,6 +178,5 @@ module Daigaku
         end
       end
     end
-
   end
 end

data/lib/daigaku/terminal/output.rb

@@ -4,7 +4,6 @@ require 'colorize'
 
 module Daigaku
   module Terminal
-
     module Output
       extend ActiveSupport::Concern
 
@@ -73,6 +72,5 @@ module Daigaku
         end
       end
     end
-
   end
 end

data/lib/daigaku/terminal/setup.rb

@@ -1,10 +1,8 @@
 require 'thor'
+require_relative 'output'
 
 module Daigaku
   module Terminal
-
-    require_relative 'output'
-
     class Setup < Thor
       include Terminal::Output
 
@@ -19,7 +17,7 @@ module Daigaku
           path = get 'path:'
 
           begin
-            @daigaku_path = File.expand_path("#{path}", Dir.pwd)
+            @daigaku_path = File.expand_path(path.to_s, Dir.pwd)
           rescue
             say_warning "#{path} is no valid path name. Try another!"
             next
@@ -29,7 +27,7 @@ module Daigaku
           say "\"#{@daigaku_path}\""
 
           confirmation = get '(yes|no)'
-          break if confirmation.downcase == 'yes'
+          break if confirmation.casecmp('yes').zero?
 
           empty_line
           say 'No Problem. Just type another one!'
@@ -61,8 +59,8 @@ module Daigaku
         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{ daigaku setup help set }
+          say_warning 'Please specify options when using this command!'
+          say `daigaku setup help set`
           return
         end
 
@@ -76,11 +74,12 @@ module Daigaku
       private
 
       def prepare_directories(path)
-        courses_dir = Daigaku::Configuration::COURSES_DIR
+        courses_dir  = Daigaku::Configuration::COURSES_DIR
         courses_path = File.join(path, courses_dir)
+
         Daigaku.config.courses_path = courses_path
 
-        solutions_dir = Daigaku::Configuration::SOLUTIONS_DIR
+        solutions_dir  = Daigaku::Configuration::SOLUTIONS_DIR
         solutions_path = File.join(path, solutions_dir)
 
         if Dir.exist? solutions_path
@@ -92,7 +91,7 @@ module Daigaku
 
         text = [
           "Your Daigaku directory is now set up.\n",
-          "Daigaku created/updated following two paths for you:",
+          'Daigaku created/updated following two paths for you:',
           courses_path,
           solutions_path
         ]
@@ -101,15 +100,11 @@ module Daigaku
       end
 
       def update_config(attribute, value)
-        begin
-          path = File.expand_path(value, Dir.pwd)
-          Daigaku.config.send("#{attribute}=", path)
-        rescue Exception => e
-          say_warning e.message
-        end
+        path = File.expand_path(value, Dir.pwd)
+        Daigaku.config.send("#{attribute}=", path)
+      rescue StandardError => e
+        say_warning e.message
       end
-
     end
-
   end
 end