lessons_indexer 0.0.2.2 → 0.1.0

data/lib/lessons_indexer/models/heading.rb

@@ -0,0 +1,6 @@
+module LessonsIndexer
+  module Models
+    class Heading < Base
+    end
+  end
+end

data/lib/lessons_indexer/models/lesson.rb

@@ -0,0 +1,17 @@
+module LessonsIndexer
+  module Models
+    class Lesson < Base
+      NAME_PATTERN = /(?<minor_major>(?<major>(\d+))(?:\.|-)(?<minor>(\d+)))(?<ext>\.md)/i
+      attr_reader :name
+
+      def initialize(file_name)
+        super file_name
+        @name = file_name.gsub(NAME_PATTERN, ' \k<minor_major>').titlecase
+      end
+
+      def link(dir)
+        "* [#{name}](#{dir}/#{file_name})\n"
+      end
+    end
+  end
+end

data/lib/lessons_indexer/options.rb

@@ -18,14 +18,14 @@ module LessonsIndexer
       begin
         Slop.parse(argv, strict: true, help: true,
                              banner: 'Welcome to Lessons Indexer. Here is the list of available options:') do |o|
-          o.string '-p', '--path', 'Path to the directory with the course', default: '.'#, argument: true
+          o.string '-p', '--path', 'Path to the directory with the course', default: '.'
           o.bool '-s', '--skip_index', 'Skip index generation for the course', default: false
-          o.string '-o', '--output', 'Output file', default: 'README.md'#, as: String, argument: true
+          o.string '-o', '--output', 'Output file', default: 'README.md'
           o.bool '-g', '--git', 'Push changes to the remote Git branch?', default: false
-          o.string '-m', '--message', 'Commit message', default: 'Added index'#, as: String, argument: true
+          o.string '-m', '--message', 'Commit message', default: 'Added index'
           o.bool '-a', '--all', 'Work with all branches (except for master)', default: false
           o.bool '-i', '--headings', 'Add heading images to the beginning of the lesson files?', default: false
-          o.string '-d', '--headings_dir', 'Relative path to the directory with heading images', default: 'headers'#, as: String, argument: true
+          o.string '-d', '--headings_dir', 'Relative path to the directory with heading images', default: 'headings'
         end.to_hash
       rescue Slop::Error => e
         exit_msg e.message

data/lib/lessons_indexer/starter.rb

@@ -7,7 +7,7 @@ module LessonsIndexer
     end
 
     def start!
-      with_messages("Welcome to Lessons Indexer ver#{LessonsIndexer::VERSION}!", "=== [ DONE. ] ===", false) do
+      with_messages("=== [ Welcome to Lessons Indexer ver#{LessonsIndexer::VERSION}! ] ===", "=== [ DONE. ] ===", false) do
         indexer = Indexer.new(options)
 
         within options.path do
@@ -15,27 +15,14 @@ module LessonsIndexer
             brancher = GitManager::Brancher.new
             brancher.get_branches.each do |branch|
               brancher.within_branch branch do
-                work_with indexer
+                indexer.do_work!
               end
             end
           else
-            work_with indexer
+            indexer.do_work!
           end
         end
       end
     end
-
-    private
-
-    def work_with(indexer)
-      indexer.build_index! unless options.skip_index
-      indexer.add_headings! if options.headings
-      git_push! if options.git
-    end
-
-    def git_push!
-      pusher = GitManager::Pusher.new(options.message)
-      pusher.push!
-    end
   end
 end

data/lib/lessons_indexer/version.rb

@@ -1,3 +1,3 @@
 module LessonsIndexer
-  VERSION = "0.0.2.2"
+  VERSION = "0.1.0"
 end

data/spec/addons/file_manager_spec.rb

@@ -1,30 +1,28 @@
-module LessonsIndexer
-  RSpec.describe Writer do
-    before :each do
-      @writer = Writer.new('test.txt')
-      @writer << 'test'
-    end
-    after(:all) {File.delete('test.txt')}
+RSpec.describe LessonsIndexer::Addons::FileManager::Writer do
+  before :each do
+    @writer = described_class.new('test.txt')
+    @writer << 'test'
+  end
+  after(:all) {File.delete('test.txt')}
 
-    specify "#name" do
-      expect(@writer.name).to eq('test.txt')
-    end
+  specify "#name" do
+    expect(@writer.name).to eq('test.txt')
+  end
 
-    specify "#<<" do
-      contents = IO.read(@writer.name)
-      expect(contents).to eq('test')
-    end
+  specify "#<<" do
+    contents = IO.read(@writer.name)
+    expect(contents).to eq('test')
+  end
 
-    context "#prepend_data" do
-      before(:each) {@writer.prepend_data('prepended')}
-      it "should add data to the beginning" do
-        expect(IO.read(@writer.name)).to eq('prependedtest')
-      end
+  context "#prepend_data" do
+    before(:each) {@writer.prepend_data('prepended')}
+    it "should add data to the beginning" do
+      expect(IO.read(@writer.name)).to eq('prependedtest')
+    end
 
-      it "should not add data to the beginning if data is already present" do
-        @writer.prepend_data('prepended')
-        expect(IO.read(@writer.name)).to eq('prependedtest')
-      end
+    it "should not add data to the beginning if data is already present" do
+      @writer.prepend_data('prepended')
+      expect(IO.read(@writer.name)).to eq('prependedtest')
     end
   end
 end

data/spec/addons/git_manager_spec.rb

@@ -0,0 +1,23 @@
+RSpec.describe LessonsIndexer::Addons::GitManager::Pusher do
+  subject {described_class.new('test message')}
+
+  specify "#message" do
+    expect(subject.message).to eq('test message')
+  end
+
+  specify { expect(subject).to respond_to(:push!) }
+end
+
+RSpec.describe LessonsIndexer::Addons::GitManager::Brancher do
+  subject {described_class.new(false)}
+
+  specify "#ignore_master" do
+    expect(subject.ignore_master).to eq(false)
+  end
+
+  specify { expect(subject).to respond_to(:within_branch) }
+
+  specify "#get_branches" do
+    expect(subject.get_branches).to include 'master'
+  end
+end

data/spec/addons/utils_spec.rb

@@ -1,66 +1,64 @@
-module Kernel
-  RSpec.describe "helper utils" do
-    context "#within" do
-      before(:all) {@original_path = Dir.getwd}
-      after(:each) {Dir.chdir(@original_path)}
+RSpec.describe Kernel do
+  context "#within" do
+    before(:all) {@original_path = Dir.getwd}
+    after(:each) {Dir.chdir(@original_path)}
 
-      it "should return result of the block" do
-        expect(Kernel.within('/') {1 + 1}).to eq(2)
-      end
-
-      it "should return immediately if no block is given" do
-        expect(Kernel.within('/')).to eq(nil)
-      end
-
-      it "should raise an error if directory does not exist" do
-        err = capture_stderr do
-          expect(-> { Kernel.within('non_existent_dir') {1 + 1} }).to raise_error(SystemExit)
-        end.uncolorize
-        expect(err).to eq("[ERROR] The provided directory non_existent_dir was not found! Aborting...\n")
-      end
+    it "should return result of the block" do
+      expect(described_class.within('/') {1 + 1}).to eq(2)
+    end
 
-      it "should return to the original directory" do
-        Kernel.within('/', true) {1 + 1}
-        expect(Dir.getwd).to eq(@original_path)
-      end
+    it "should return immediately if no block is given" do
+      expect(described_class.within('/')).to eq(nil)
+    end
 
-      it "should not return to the original directory by default" do
-        Kernel.within('/') {1 + 1}
-        expect(Dir.getwd).not_to eq(@original_path)
-      end
+    it "should raise an error if directory does not exist" do
+      err = capture_stderr do
+        expect(-> { described_class.within('non_existent_dir') {1 + 1} }).to raise_error(SystemExit)
+      end.uncolorize
+      expect(err).to eq("[ERROR] The provided directory non_existent_dir was not found! Aborting...\n")
     end
 
-    context "#with_messages" do
-      let(:after_msg) {"after"}
-      let(:before_msg) {"before"}
-      it "should handle block and display messages and delimiter" do
-        info = capture_stdout do
-          with_messages(before_msg, after_msg) { 1 + 1 }
-        end.uncolorize
-        expect(info).to eq("#{before_msg}\n#{after_msg}\n#{'=' * 50}\n")
-      end
+    it "should return to the original directory" do
+      described_class.within('/', true) {1 + 1}
+      expect(Dir.getwd).to eq(@original_path)
+    end
 
-      it "should not display delimiter when false is passed" do
-        info = capture_stdout do
-          with_messages(before_msg, after_msg, false) { 1 + 1 }
-        end.uncolorize
-        expect(info).to eq("#{before_msg}\n#{after_msg}\n")
-      end
+    it "should not return to the original directory by default" do
+      described_class.within('/') {1 + 1}
+      expect(Dir.getwd).not_to eq(@original_path)
     end
+  end
 
-    specify "#warning" do
-      expect(Kernel).to respond_to(:warning)
-      err = capture_stderr do
-        warning "alert"
+  context "#with_messages" do
+    let(:after_msg) {"after"}
+    let(:before_msg) {"before"}
+    it "should handle block and display messages and delimiter" do
+      info = capture_stdout do
+        with_messages(before_msg, after_msg) { 1 + 1 }
       end.uncolorize
-      expect(err).to eq("[WARNING] alert\n")
+      expect(info).to eq("#{before_msg}\n#{after_msg}\n#{'=' * 50}\n")
     end
 
-    specify "#exit_msg" do
-      err = capture_stderr do
-        expect(-> {exit_msg('critical')}).to raise_error(SystemExit)
+    it "should not display delimiter when false is passed" do
+      info = capture_stdout do
+        with_messages(before_msg, after_msg, false) { 1 + 1 }
       end.uncolorize
-      expect(err).to eq("[ERROR] critical\n")
+      expect(info).to eq("#{before_msg}\n#{after_msg}\n")
     end
   end
+
+  specify "#warning" do
+    expect(described_class).to respond_to(:warning)
+    err = capture_stderr do
+      warning "alert"
+    end.uncolorize
+    expect(err).to eq("[WARNING] alert\n")
+  end
+
+  specify "#exit_msg" do
+    err = capture_stderr do
+      expect(-> {exit_msg('critical')}).to raise_error(SystemExit)
+    end.uncolorize
+    expect(err).to eq("[ERROR] critical\n")
+  end
 end

data/spec/collections/headings_list_spec.rb

@@ -0,0 +1,28 @@
+RSpec.describe LessonsIndexer::Collections::HeadingsList do
+  subject { sample_headings }
+
+  context "#for" do
+    it "should return heading for a lesson" do
+      lesson = double('lesson', major: 2, minor: 5)
+      expect(subject.for(lesson)).to eq(subject.first)
+    end
+
+    it "should return nil if heading does not exist" do
+      lesson = double('lesson', major: 10, minor: 5)
+      expect(subject.for(lesson)).to be_nil
+    end
+  end
+
+  context "#list" do
+    it "should respond to #each" do
+      expect(subject).to respond_to(:each)
+    end
+
+    it "should be sorted properly" do
+      sorted_headings = subject.sort
+      %w(1.3 2.5 5.8 10.2).each_with_index do |version, index|
+        expect(sorted_headings[index].file_name).to eq "lesson#{version}.jpg"
+      end
+    end
+  end
+end

data/spec/collections/lessons_list_spec.rb

@@ -0,0 +1,16 @@
+RSpec.describe LessonsIndexer::Collections::LessonsList do
+  subject { sample_lessons }
+
+  context "#list" do
+    it "should respond to #each" do
+      expect(subject).to respond_to(:each)
+    end
+
+    it "should be sorted properly" do
+      sorted_lessons = subject.sort
+      %w(1.3 2.5 5.8 10.2).each_with_index do |version, index|
+        expect(sorted_lessons[index].file_name).to eq "lesson#{version}.md"
+      end
+    end
+  end
+end

data/spec/course_spec.rb

@@ -0,0 +1,89 @@
+RSpec.describe LessonsIndexer::Course do
+  subject {described_class.new('my_course_handouts', 'headings')}
+
+  specify "#dir" do
+    expect(subject.dir).to eq('my_course_handouts')
+  end
+
+  specify "#title" do
+    expect(subject.title).to eq('My Course')
+  end
+
+  specify "#headings_dir" do
+    expect(subject.headings_dir).to eq('headings')
+  end
+
+  specify "#headings" do
+    expect(subject.headings).to eq([])
+  end
+
+  specify "#generate_index" do
+    expect(subject).to receive(:lessons).and_return(sample_lessons)
+    expect(subject.generate_index).to eq("# Index for the My Course course\n\n* [Lesson 1.3](my_course_handouts/lesson1.3.md)\n* [Lesson 2.5](my_course_handouts/lesson2.5.md)\n* [Lesson 5.8](my_course_handouts/lesson5.8.md)\n* [Lesson 10.2](my_course_handouts/lesson10.2.md)\n")
+  end
+
+  context "#generate_headings" do
+    it "should return formatted heading and path to file" do
+      expect(subject).to receive(:lessons).and_return(sample_lessons)
+      expect(subject).to receive(:headings).and_return(sample_headings).exactly(4).times
+      expect {|block| subject.generate_headings(&block)}.to yield_successive_args(
+                                                              ["![](headings/lesson2.5.jpg)\n\n", "#{Dir.pwd}/lesson2.5.md"],
+                                                              ["![](headings/lesson10.2.jpg)\n\n", "#{Dir.pwd}/lesson10.2.md"],
+                                                              ["![](headings/lesson1.3.jpg)\n\n", "#{Dir.pwd}/lesson1.3.md"],
+                                                              ["![](headings/lesson5.8.jpg)\n\n", "#{Dir.pwd}/lesson5.8.md"]
+                                                            )
+    end
+
+    it "should warn if heading is not found" do
+      expect(subject).to receive(:lessons).and_return(sample_lessons(true))
+      expect(subject).to receive(:headings).and_return(sample_headings).exactly(5).times
+      err = capture_stderr do
+        expect {|block| subject.generate_headings(&block)}.to yield_successive_args(
+                                                                ["![](headings/lesson2.5.jpg)\n\n", "#{Dir.pwd}/lesson2.5.md"],
+                                                                ["![](headings/lesson10.2.jpg)\n\n", "#{Dir.pwd}/lesson10.2.md"],
+                                                                ["![](headings/lesson1.3.jpg)\n\n", "#{Dir.pwd}/lesson1.3.md"],
+                                                                ["![](headings/lesson5.8.jpg)\n\n", "#{Dir.pwd}/lesson5.8.md"]
+                                                              )
+      end.uncolorize
+      expect(err).to eq("[WARNING] I was not able to find heading image for the Lesson 6.3\n")
+    end
+  end
+
+  context "file system access" do
+    before(:all) { setup_env! }
+
+    after(:all) { clear_env! }
+
+    context "#load_headings!" do
+      let(:headings) {subject.load_headings!}
+
+      specify { expect(headings).to be_a LessonsIndexer::Collections::HeadingsList }
+
+      specify { expect(headings.map {|l| l.file_name}).not_to include('test2.png') }
+
+      it "should have four items" do
+        expect(headings.map {|l| l.file_name}.length).to eq(4)
+      end
+
+      specify "heading should be a kind of LessonsIndexer::Models::Heading" do
+        expect(headings.first).to be_a LessonsIndexer::Models::Heading
+      end
+    end
+
+    context "#load_lessons!" do
+      let(:lessons) {subject.load_lessons!}
+
+      specify { expect(lessons).to be_a LessonsIndexer::Collections::LessonsList }
+
+      specify { expect(lessons.map {|l| l.name}).not_to include('Test') }
+
+      it "should have four items" do
+        expect(lessons.map {|l| l.name}.length).to eq(4)
+      end
+
+      specify "lesson should be a kind of LessonsIndexer::Models::Lesson" do
+        expect(lessons.first).to be_a LessonsIndexer::Models::Lesson
+      end
+    end
+  end
+end

data/spec/indexer_spec.rb

@@ -0,0 +1,83 @@
+RSpec.describe LessonsIndexer::Indexer do
+  before(:all) { setup_env! }
+  after(:all) { clear_env! }
+
+  subject { described_class.new(LessonsIndexer::Options.new(sample_options)) }
+  let(:course) {LessonsIndexer::Course.new(subject.get_course_dir, subject.options.headings_dir)}
+
+  context "#options" do
+    it "should return output" do
+      expect(subject.options.output).to eq('test.md')
+    end
+  end
+
+  context "#do_work!" do
+    it "should build index if --skip_index is not set" do
+      expect(subject).to receive(:build_index)
+      expect(subject).not_to receive(:add_headings)
+      expect(subject).not_to receive(:git_push!)
+      capture_stdout { subject.do_work! }
+    end
+
+    it "should add headings if --headings is set" do
+      allow(subject.options).to receive(:skip_index).and_return(true)
+      allow(subject.options).to receive(:headings).and_return(true)
+      expect(subject).to receive(:add_headings)
+      expect(subject).not_to receive(:build_index)
+      expect(subject).not_to receive(:git_push!)
+      capture_stdout { subject.do_work! }
+    end
+
+    it "should push to github if --git is set" do
+      allow(subject.options).to receive(:skip_index).and_return(true)
+      allow(subject.options).to receive(:git).and_return(true)
+      expect(subject).to receive(:git_push!)
+      expect(subject).not_to receive(:build_index)
+      expect(subject).not_to receive(:add_headings)
+      capture_stdout { subject.do_work! }
+    end
+  end
+
+  context "#get_course_dir" do
+    it "should return course dir" do
+      expect(subject.get_course_dir)
+    end
+
+    it "should abort if course dir is not found" do
+      Kernel.within 'my_course_handouts', true do
+        err = capture_stderr do
+          expect(-> {subject.get_course_dir}).to raise_error(SystemExit)
+        end.uncolorize
+        expect(err).to eq("[ERROR] Lesson files were not found inside the provided directory. Aborting...\n")
+      end
+    end
+  end
+
+  context "#build_index" do
+    it "should display proper info messages" do
+      info = capture_stdout do
+        subject.build_index(course)
+      end.uncolorize
+      expect(info).to eq("Starting to build index...\nIndex for the My Course course is generated!\n#{'=' * 50}\n")
+    end
+
+    it "should generate proper index" do
+      capture_stdout { subject.build_index(course) }
+      expect(IO.read('test.md')).to eq("# Index for the My Course course\n\n* [Lesson 1.3](my_course_handouts/lesson1.3.md)\n* [Lesson 2.5](my_course_handouts/lesson2.5.md)\n* [Lesson 5.8](my_course_handouts/lesson5.8.md)\n* [Lesson 10.2](my_course_handouts/lesson10.2.md)\n")
+    end
+  end
+
+  context "#add_headings" do
+    it "should display proper info messages" do
+      info = capture_stdout do
+        subject.add_headings(course)
+      end.uncolorize
+      expect(info).to eq("Starting to add headings...\nHeadings for the lesson files of My Course course were added!\n#{'=' * 50}\n")
+    end
+
+    it "should generate proper index" do
+      capture_stdout { subject.add_headings(course) }
+      expect(IO.read('my_course_handouts/lesson10.2.md')).to eq("![](headings/lesson10.2.jpg)\n\n")
+    end
+  end
+end