daigaku 0.3.0 → 0.4.0

data/lib/daigaku/window.rb

@@ -11,8 +11,8 @@ module Daigaku
       init_colors
     end
 
-    def write(text, color = COLOR_TEXT, text_decoration = Curses::A_NORMAL )
-      self.attron(Curses.color_pair(color) | text_decoration) { self << text.to_s }
+    def write(text, color = COLOR_TEXT, text_decoration = Curses::A_NORMAL)
+      attron(Curses.color_pair(color) | text_decoration) { self << text.to_s }
     end
 
     def emphasize(text, text_decoration = Curses::A_NORMAL)
@@ -50,13 +50,13 @@ module Daigaku
       write("#{prefix}#{text}", color, text_decoration)
     end
 
-    # clear_line(options =  {})
-    # options: [:color, :text_decoration, :start_pos, :end_pos]
+    # clear_line(options = {})
+    # options: [:color, :text_decoration, :start_pos, :end_pos, :text]
     def clear_line(options = {})
-      color = options[:color] || COLOR_TEXT
+      color           = options[:color] || COLOR_TEXT
       text_decoration = options[:text_decoration] || Curses::A_NORMAL
-      start = options[:start_pos] || 0
-      stop = options[:end_pos] || maxx
+      start           = options[:start_pos] || 0
+      stop            = options[:end_pos] || maxx
 
       x = curx
       setpos(cury, start)
@@ -69,85 +69,27 @@ module Daigaku
       if object.respond_to?(:mastered?) && object.respond_to?(:started?)
         if object.mastered?
           green(text, text_decoration)
-          write ' '
         elsif object.started?
           yellow(text, text_decoration)
-          write ' '
         else
           red(text, text_decoration)
-          write ' '
         end
       elsif object.respond_to?(:mastered?)
         if object.mastered?
           green(text, text_decoration)
-          write ' '
         else
           red(text, text_decoration)
-          write ' '
         end
       end
+
+      write ' '
     end
 
     def print_markdown(text)
       clear_line
 
-      h1 = /^\#{1}[^#]+/    # '# heading'
-      h2 = /^\#{2}[^#]+/    # '## sub heading'
-      bold = /(\*[^*]*\*)/  # '*text*'
-      line = /^-{3,}/       # '---' vertical line
-      code = /(\`*\`)/      # '`code line`'
-      ruby_doc_core = /(\(ruby-doc core:.*\))/ # '(ruby-doc core: Kernel#print)'
-      ruby_doc_stdlib = /(\(ruby-doc stdlib:.*\))/ # '(ruby-doc stdlib: CSV#Row::<<)'
-
-      text = Markdown::RubyDoc.parse(text)
-
-      case text
-      when h1
-        heading(text.gsub(/^#\s?/, ''))
-      when h2
-        text_decoration = Curses::A_UNDERLINE | Curses::A_NORMAL
-        emphasize(text.gsub(/^##\s?/, ''), text_decoration)
-      when (code || bold)
-        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
-            red(character)
-          elsif emphasized
-            emphasize(character)
-          else
-            write(character)
-          end
-        end
-      when bold
-        text.chars.each_with_index do |char, index|
-          if char == '*' && text[index - 1] != '\\'
-            emphasized = !emphasized
-            next
-          end
-
-          character = "#{text[index..(index + 1)]}" == '\\*' ? '' : char
-          emphasized ? emphasize(character) : write(character)
-        end
-      when line
-        write('-' * (Curses.cols - 2))
-      else
-        write(text.gsub(/(\\#)/, '#'))
-      end
+      printer = Markdown::Printer.new(window: self)
+      printer.print(text)
     end
-
   end
-end
+end

data/spec/daigaku/chapter_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Daigaku::Chapter do
-
   it { is_expected.to respond_to :title }
   it { is_expected.to respond_to :units }
   it { is_expected.to respond_to :path }
@@ -18,58 +17,64 @@ describe Daigaku::Chapter do
 
   subject { Daigaku::Chapter.new(chapter_path) }
 
-  it "has the prescribed title" do
+  it 'has the prescribed title' do
     expect(subject.title).to eq chapter_titles.first
   end
 
-  it "has the prescribed path" do
+  it 'has the prescribed path' do
     expect(subject.path).to eq chapter_path
   end
 
-  it "is not started by default" do
+  it 'is not started by default' do
     expect(subject.started?).to be_falsey
   end
 
-  it "is not mastered by default" do
+  it 'is not mastered by default' do
     expect(subject.mastered?).to be_falsey
   end
 
-  describe "#units" do
-    it "loads the prescribed number of units" do
+  describe '#units' do
+    it 'loads the prescribed number of units' do
       course_name = course_dir_names.first
       chapter_name = File.basename(chapter_path)
       units_count = available_units(course_name, chapter_name).count
       expect(subject.units.count).to eq units_count
     end
 
-    it "lazy-loads the units" do
+    it 'lazy-loads the units' do
       expect(subject.instance_variable_get(:@units)).to be_nil
       subject.units
       expect(subject.instance_variable_get(:@units)).not_to be_nil
     end
   end
 
-  describe "#started?" do
-    it "returns true if at least one unit has been verified" do
-      allow(subject.units.first).to receive(:mastered?) { true }
+  describe '#started?' do
+    it 'returns true if at least one unit has been verified' do
+      allow(subject.units.first).to receive(:mastered?).and_return(true)
       expect(subject.started?).to be true
     end
 
-    it "returns false if no unit has been verified" do
-      allow_any_instance_of(Daigaku::Unit).to receive(:mastered?) { false }
+    it 'returns false if no unit has been verified' do
+      allow_any_instance_of(Daigaku::Unit)
+        .to receive(:mastered?)
+        .and_return(false)
+
       expect(subject.started?).to be false
     end
   end
 
-  describe "#mastered?" do
-    it "returns true if all units have been verified" do
+  describe '#mastered?' do
+    it 'returns true if all units have been verified' do
       subject.units.each { |unit| unit.solution.verify! }
       expect(subject.mastered?).to be true
     end
 
-    it "returns false unless all units have been verified" do
-      allow_any_instance_of(Daigaku::Unit).to receive(:mastered?) { false }
-      allow(subject.units.first).to receive(:mastered?) { true }
+    it 'returns false unless all units have been verified' do
+      allow_any_instance_of(Daigaku::Unit)
+        .to receive(:mastered?)
+        .and_return(false)
+
+      allow(subject.units.first).to receive(:mastered?).and_return(true)
       expect(subject.mastered?).to be false
     end
   end

data/spec/daigaku/coloring_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Daigaku::Coloring do
-
   subject do
     class Example
       include Daigaku::Coloring

data/spec/daigaku/configuration_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Daigaku::Configuration do
-
   subject { Daigaku::Configuration.send(:new) }
 
   it { is_expected.to respond_to :solutions_path }
@@ -10,85 +9,90 @@ describe Daigaku::Configuration do
   it { is_expected.to respond_to :courses_path= }
   it { is_expected.to respond_to :storage_file }
   it { is_expected.to respond_to :save }
-  it { is_expected.to respond_to :import! }
+  it { is_expected.to respond_to :import }
   it { is_expected.to respond_to :summary }
 
   before do
     subject.instance_variable_set(:@storage_file, local_storage_file)
+    File.open(local_storage_file, 'w')
   end
 
-  describe "#courses_path" do
-    it "returns the appropriate initial local courses path" do
+  describe '#courses_path' do
+    it 'returns the appropriate initial local courses path' do
       courses_path = File.expand_path('~/.daigaku/courses', __FILE__)
       expect(subject.courses_path).to eq courses_path
     end
 
-    it "returns the appropriate set courses path" do
+    it 'returns the appropriate set courses path' do
       subject.courses_path = local_courses_path
       expect(subject.courses_path).to eq local_courses_path
     end
   end
 
-  describe "#solutions_path=" do
-    it "raises an error if the given path is no existent dir" do
-      expect { subject.solutions_path = "no/existent/dir" }
-        .to raise_error(Daigaku::ConfigurationError)
+  describe '#solutions_path=' do
+    context 'if the given path is no existent dir' do
+      it 'raises a configuration error' do
+        expect { subject.solutions_path = 'no/existent/dir' }
+          .to raise_error(Daigaku::ConfigurationError)
+      end
     end
   end
 
-  describe "#solutions_path" do
-    it "raises an error if not set" do
-      expect { subject.solutions_path }
-        .to raise_error(Daigaku::ConfigurationError)
+  describe '#solutions_path' do
+    context 'if not set' do
+      it 'raises an error' do
+        expect { subject.solutions_path }
+          .to raise_error(Daigaku::ConfigurationError)
+      end
     end
 
-    it "returns the solutions path if set" do
-      subject.solutions_path = test_basepath
-      expect { subject.solutions_path }.not_to raise_error
+    context 'if set' do
+      it 'returns the solutions path' do
+        subject.solutions_path = test_basepath
+        expect(subject.solutions_path).to eq test_basepath
+      end
     end
   end
 
-  describe "#storage_path" do
-    it "returns the appropriate path to the storage file" do
+  describe '#storage_path' do
+    it 'returns the appropriate path to the storage file' do
       expect(subject.storage_file).to eq local_storage_file
     end
   end
 
-  describe "#save" do
-    it "saves the configured courses path to the daigaku store" do
+  describe '#save' do
+    it 'saves the configured courses path to the daigaku store' do
       subject.courses_path = local_courses_path
       subject.save
 
       expect(QuickStore.store.courses_path).to eq local_courses_path
     end
 
-    it "saves the configured solution_path to the daigaku store" do
+    it 'saves the configured solution_path to the daigaku store' do
       path = File.join(test_basepath, 'test_solutions')
-      FileUtils.makedirs(path)
+      create_directory(path)
       subject.solutions_path = path
       subject.save
 
       expect(QuickStore.store.solutions_path).to eq path
     end
 
-    it "does not save the storage file path" do
+    it 'does not save the storage file path' do
       subject.save
       expect(QuickStore.store.storage_file).to be_nil
     end
   end
 
-  describe "#import!" do
-    context "with non-existent daigaku store entries:" do
-      before  do
-        FileUtils.rm(local_storage_file) if File.exist?(local_storage_file)
-      end
+  describe '#import' do
+    context 'with non-existent daigaku store entries:' do
+      before { remove_file(local_storage_file) }
 
-      it "uses the default configuration" do
-        QuickStore.store.courses_path = nil
+      it 'uses the default configuration' do
+        QuickStore.store.courses_path   = nil
         QuickStore.store.solutions_path = nil
         subject.instance_variable_set(:@courses_path, local_courses_path)
 
-        loaded_config = subject.import!
+        loaded_config = subject.import
 
         expect(loaded_config.courses_path).to eq local_courses_path
         expect { loaded_config.solutions_path }
@@ -96,17 +100,18 @@ describe Daigaku::Configuration do
       end
     end
 
-    context "with existing daigaku storage file:" do
-      it "returns a Daigaku::Configuration" do
-        expect(subject.import!).to be_a Daigaku::Configuration
+    context 'with existing daigaku storage file:' do
+      it 'returns a Daigaku::Configuration' do
+        expect(subject.import).to be_a Daigaku::Configuration
       end
 
-      it "loads the daigaku store entries into the configuration" do
-        wanted_courses_path = "/courses/path"
+      it 'loads the daigaku store entries into the configuration' do
+        wanted_courses_path   = '/courses/path'
         wanted_solutions_path = solutions_basepath
-        temp_solutions_path = File.join(solutions_basepath, 'temp')
-        FileUtils.makedirs(wanted_solutions_path)
-        FileUtils.makedirs(temp_solutions_path)
+        temp_solutions_path   = File.join(solutions_basepath, 'temp')
+
+        create_directory(wanted_solutions_path)
+        create_directory(temp_solutions_path)
 
         # save wanted settings
         subject.courses_path = wanted_courses_path
@@ -114,11 +119,11 @@ describe Daigaku::Configuration do
         subject.save
 
         # overwrite in memory settings
-        subject.courses_path = '/some/other/path/'
+        subject.courses_path   = '/some/other/path/'
         subject.solutions_path = temp_solutions_path
 
         # fetch stored settings
-        subject.import!
+        subject.import
         expect(File.exist?(local_storage_file)).to be_truthy
         expect(subject.courses_path).to eq wanted_courses_path
         expect(subject.solutions_path).to eq wanted_solutions_path
@@ -128,34 +133,33 @@ describe Daigaku::Configuration do
 
   describe '#summary' do
     before do
-      subject.courses_path = "wanted/courses/path"
+      subject.courses_path   = 'wanted/courses/path'
       subject.solutions_path = solutions_basepath
-      @summary = subject.summary
+      @summary               = subject.summary
     end
 
-    it "returns a string" do
+    it 'returns a string' do
       expect(@summary).to be_a String
     end
 
-    it "returns a string with all properties but @configuration_file" do
+    it 'returns a string with all properties but @configuration_file' do
       expect(@summary.lines.count).to eq subject.instance_variables.count - 1
     end
 
-    it "returns a string including the courses path" do
+    it 'returns a string including the courses path' do
       expect(@summary =~ /courses path/).to be_truthy
     end
 
-    it "returns a string including the courses path" do
+    it 'returns a string including the courses path' do
       expect(@summary =~ /solutions path/).to be_truthy
     end
   end
 
   describe '#initial_course' do
-    it {  is_expected.to respond_to :initial_course }
+    it { is_expected.to respond_to :initial_course }
 
-    it "returns the initial course github repo partial path" do
+    it 'returns the initial course github repo partial path' do
       expect(subject.initial_course).to eq 'daigaku-ruby/Get_started_with_Ruby'
     end
   end
-
 end

data/spec/daigaku/congratulator_spec.rb

@@ -1,23 +1,26 @@
 require 'spec_helper'
 
 describe Daigaku::Congratulator do
-
-  it "responds to #message" do
+  it 'responds to #message' do
     expect(Daigaku::Congratulator).to respond_to :message
   end
 
-  describe "#message" do
-    it "returns a string" do
+  describe '#message' do
+    it 'returns a string' do
       expect(Daigaku::Congratulator.message).to be_a String
     end
 
-    it "returns a random congratulation method" do
-      messages = 1.upto(10).map { |i| Daigaku::Congratulator.message }
+    it 'returns a random congratulation method' do
+      messages = 1.upto(10).map { |_| Daigaku::Congratulator.message }
       expect(messages.uniq.count).to be > 1
     end
 
-    it "receives the congratulation texts from a Terminal text" do
-      expect(Daigaku::Terminal).to receive(:text).with(:congratulations) { '' }
+    it 'receives the congratulation texts from a Terminal text' do
+      expect(Daigaku::Terminal)
+        .to receive(:text)
+        .with(:congratulations)
+        .and_return('')
+
       Daigaku::Congratulator.message
     end
   end