belajar 0.1.1 → 1.0.0

data/spec/belajar/configuration_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Belajar::Configuration do
-
   subject { Belajar::Configuration.send(:new) }
 
   it { is_expected.to respond_to :solutions_path }
@@ -10,85 +9,90 @@ describe Belajar::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('~/.belajar/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(Belajar::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(Belajar::ConfigurationError)
+      end
     end
   end
 
-  describe "#solutions_path" do
-    it "raises an error if not set" do
-      expect { subject.solutions_path }
-        .to raise_error(Belajar::ConfigurationError)
+  describe '#solutions_path' do
+    context 'if not set' do
+      it 'raises an error' do
+        expect { subject.solutions_path }
+          .to raise_error(Belajar::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 belajar store" do
+  describe '#save' do
+    it 'saves the configured courses path to the belajar 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 belajar store" do
+    it 'saves the configured solution_path to the belajar 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 belajar store entries:" do
-      before  do
-        FileUtils.rm(local_storage_file) if File.exist?(local_storage_file)
-      end
+  describe '#import' do
+    context 'with non-existent belajar 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 Belajar::Configuration do
       end
     end
 
-    context "with existing belajar storage file:" do
-      it "returns a Belajar::Configuration" do
-        expect(subject.import!).to be_a Belajar::Configuration
+    context 'with existing belajar storage file:' do
+      it 'returns a Belajar::Configuration' do
+        expect(subject.import).to be_a Belajar::Configuration
       end
 
-      it "loads the belajar store entries into the configuration" do
-        wanted_courses_path = "/courses/path"
+      it 'loads the belajar 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 Belajar::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 Belajar::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
-      expect(subject.initial_course).to eq 'wong-bejo/Get_started_with_Ruby'
+    it 'returns the initial course github repo partial path' do
+      expect(subject.initial_course).to eq 'wong-bejo/Belajar_Ruby'
     end
   end
-
 end

data/spec/belajar/congratulator_spec.rb

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

data/spec/belajar/course_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Belajar::Course do
-
   it { is_expected.to respond_to :title }
   it { is_expected.to respond_to :chapters }
   it { is_expected.to respond_to :path }
@@ -22,73 +21,82 @@ describe Belajar::Course do
 
   subject { Belajar::Course.new(course_path) }
 
-  it "responds to ::unzip" do
+  it 'responds to .unzip' do
     expect(Belajar::Course).to respond_to :unzip
   end
 
-  it "has the prescribed title" do
+  it 'has the prescribed title' do
     expect(subject.title).to eq course_titles.first
   end
 
-  it "has the prescribed path" do
+  it 'has the prescribed path' do
     expect(subject.path).to eq course_path
   end
 
-  it "is not started by default" do
-    expect(subject.started?).to be_falsey
+  it 'is not started by default' do
+    expect(subject.started?).to be false
   end
 
-  it "is not mastered by default" do
-    expect(subject.mastered?).to be_falsey
+  it 'is not mastered by default' do
+    expect(subject.mastered?).to be false
   end
 
-  describe "#chapters" do
-    it "loads the prescribed number of chapters" do
+  describe '#chapters' do
+    it 'loads the prescribed number of chapters' do
       expect(subject.chapters.count).to eq available_chapters(course_path).count
     end
 
-    it "lazy-loads the chapters" do
+    it 'lazy-loads the chapters' do
       expect(subject.instance_variable_get(:@chapters)).to be_nil
       subject.chapters
       expect(subject.instance_variable_get(:@chapters)).not_to be_nil
     end
   end
 
-  describe "#started?" do
-    it "returns true if at least one chapter has been started" do
-      allow(subject.chapters.first).to receive(:started?) { true }
+  describe '#started?' do
+    it 'returns true if at least one chapter has been started' do
+      allow(subject.chapters.first).to receive(:started?).and_return(true)
       expect(subject.started?).to be true
     end
 
-    it "returns false if no chapter has been started" do
-      allow_any_instance_of(Belajar::Chapter).to receive(:started?) { false }
+    it 'returns false if no chapter has been started' do
+      allow_any_instance_of(Belajar::Chapter)
+        .to receive(:started?)
+        .and_return(false)
+
       expect(subject.started?).to be false
     end
   end
 
-  describe "#mastered?" do
-    it "returns true if all chapters have been mastered" do
-      allow_any_instance_of(Belajar::Chapter).to receive(:mastered?) { true }
+  describe '#mastered?' do
+    it 'returns true if all chapters have been mastered' do
+      allow_any_instance_of(Belajar::Chapter)
+        .to receive(:mastered?)
+        .and_return(true)
+
       expect(subject.mastered?).to be true
     end
 
-    it "returns false unless all chapters have been mastered" do
-      allow_any_instance_of(Belajar::Chapter).to receive(:mastered?) { false }
-      allow(subject.chapters.first).to receive(:mastered?) { true }
+    it 'returns false unless all chapters have been mastered' do
+      allow_any_instance_of(Belajar::Chapter)
+        .to receive(:mastered?)
+        .and_return(false)
+
+      allow(subject.chapters.first).to receive(:mastered?).and_return(true)
       expect(subject.mastered?).to be false
     end
   end
 
-  describe "#key" do
-    it "returns the courses store key for the given key name" do
-      allow(subject).to receive(:title) { '1-Course title' }
-      key = "courses/course_title/some_key"
+  describe '#key' do
+    it 'returns the courses store key for the given key name' do
+      allow(subject).to receive(:title).and_return('1-Course title')
+      key = 'courses/course_title/some_key'
       expect(subject.key('1-some Key')).to eq key
     end
   end
 
-  describe "#author" do
-    it "returns the author of Github courses form the store" do
+  describe '#author' do
+    it 'returns the author of Github courses form the store' do
       author = 'author'
       QuickStore.store.set(subject.key(:author), author)
 
@@ -97,77 +105,87 @@ describe Belajar::Course do
     end
   end
 
-  describe "::unzip" do
+  describe '.unzip' do
     before do
       Belajar.config.courses_path = local_courses_path
-      @zip_file_name = "unzip/repo.zip"
+
+      @zip_file_name = 'unzip/repo.zip'
       @zip_file_path = File.join(courses_basepath, @zip_file_name)
-      @file_content = prepare_download(@zip_file_name)
+      @file_content  = prepare_download(@zip_file_name)
     end
 
     after do
       cleanup_download(@zip_file_name)
       dir = File.dirname(@zip_file_path)
-      FileUtils.rm_r(dir) if Dir.exist?(dir)
+      remove_directory(dir)
     end
 
     def expect_course_dirs_exists_to_be(boolean)
       unit_dirs(course_dir_names.first).each do |chapter_dirs|
         chapter_dirs.each do |dir|
-          path = [dir.split('/')[0..-4], 'unzip', dir.split('/')[-3..-1]].join('/')
+          path = [
+            dir.split('/')[0..-4],
+            'unzip',
+            dir.split('/')[-3..-1]
+          ].join('/')
+
           expect(Dir.exist?(path)).to be boolean
         end
       end
     end
 
-    it "unzips a course zip file" do
+    it 'unzips a course zip file' do
       expect_course_dirs_exists_to_be false
       Belajar::Course.unzip(@zip_file_path)
       expect_course_dirs_exists_to_be true
     end
 
-    it "returns the unzipped course" do
-      dir = course_dirs.first
-      path = File.join(File.dirname(dir), 'unzip', File.basename(dir))
-      course = Belajar::Course.new(path)
+    it 'returns the unzipped course' do
+      dir    = course_dirs.first
+      path   = File.join(File.dirname(dir), 'unzip', File.basename(dir))
 
-      expect(Belajar::Course.unzip(@zip_file_path).to_json).to eql course.to_json
+      actual = Belajar::Course.unzip(@zip_file_path)
+      expected = Belajar::Course.new(path)
+
+      expect(actual.path).to eq expected.path
+      expect(actual.title).to eq expected.title
+      expect(actual.author).to eq expected.author
     end
 
-    it "removes the zip file" do
+    it 'removes the zip file' do
       expect(File.exist?(@zip_file_path)).to be true
       Belajar::Course.unzip(@zip_file_path)
       expect(File.exist?(@zip_file_path)).to be false
     end
 
-    context "with the same course already available:" do
+    context 'with the same course already available' do
       before do
         dir = course_dirs.first
         @path = File.join(File.dirname(dir), 'unzip', File.basename(dir))
         @old_chapter_dir = File.join(@path, 'Old_chapter')
 
-        FileUtils.mkdir_p(@old_chapter_dir)
+        create_directory(@old_chapter_dir)
       end
 
-      it "overwrites all chapters" do
+      it 'overwrites all chapters' do
         expect(Dir.exist?(@old_chapter_dir)).to be true
         Belajar::Course.unzip(@zip_file_path)
         expect(Dir.exist?(@old_chapter_dir)).to be false
       end
 
-      context "if an errior occurs" do
+      context 'if an error occurs' do
         before do
           allow_any_instance_of(Zip::File)
-            .to receive(:extract) { raise Exception.new }
+            .to receive(:extract) { raise StandardError.new, 'error' }
         end
 
-        it "restores an old state if an error occurs" do
+        it 'restores an old state' do
           Belajar::Course.unzip(@zip_file_path)
           expect(Dir.exist?(@old_chapter_dir)).to be true
           expect(Dir.exist?("#{@path}_old")).to be false
         end
 
-        it "keeps the zip file if an error occurs" do
+        it 'keeps the zip file' do
           expect(File.exist?(@zip_file_path)).to be true
           Belajar::Course.unzip(@zip_file_path)
           expect(File.exist?(@zip_file_path)).to be true
@@ -175,12 +193,12 @@ describe Belajar::Course do
       end
     end
 
-    context "with the github_repo option:" do
+    context 'with the github_repo option:' do
       before { @github_course_dir = prepare_github_course }
-      after { FileUtils.rm_r(@github_course_dir) }
+      after  { remove_directory(@github_course_dir) }
 
-      it "removes the '-master' from the root directory" do
-        zip_file_name = "unzip/repo-master.zip"
+      it 'removes the "-master" from the root directory' do
+        zip_file_name = 'unzip/repo-master.zip'
         zip_file_path = File.join(courses_basepath, zip_file_name)
         prepare_github_download(zip_file_name)
 
@@ -189,7 +207,12 @@ describe Belajar::Course do
 
         unit_dirs("#{course_dir_names.first}-master").each do |chapter_dirs|
           chapter_dirs.each do |dir|
-            path = [dir.split('/')[0..-4], 'unzip', dir.split('/')[-3..-1]].join('/')
+            path = [
+              dir.split('/')[0..-4],
+              'unzip',
+              dir.split('/')[-3..-1]
+            ].join('/')
+
             expect(Dir.exist?(path)).to be false
           end
         end