lessons_indexer 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cf9dd26d4596d4b4fe904c7e1cfa6989a89de64
-  data.tar.gz: b6e93014db8823c91920027df9a5c2884554a3ec
+  metadata.gz: f793d2c80b4ec88c038e6a62cd5fd370bda0eeff
+  data.tar.gz: 04f95e63497298e61a3a9c0c024acc294cbab813
 SHA512:
-  metadata.gz: 98cffc5c91e39187dfc5cde41e3a18b76d4709d8a69d781f0e058082a4fa8de141f47a00256b1641d9fdbfe6b02b11f18937e8c2a4664e71dec6cdaa9c802785
-  data.tar.gz: 4407bfebba3ec618c353d92db5c817e03313d6fe22b09e964a8cc3f79223eed71725e7ba52b67e2b6d4cb5a1e6388a777dd420c5d38b8a0bc0c5fdaf08ca6615
+  metadata.gz: 906f130d13874fb3723307e82920fa53fdf0de25614e0ae6a9a54b01c4ac85390d6f9173cf96f7156ffc28f3e39499079055e9fb6ab34a602665ed96ac260a2d
+  data.tar.gz: e222988ff131ff03152a46a53482467cc10ef76a1d80f56e3b977001b7bbd5affd49ecfb5d052de7503b42295d5065bbda7ae9d0439d5a4153e6259493166d19

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - 2.0.0
   - 2.1.5
   - 2.2.2
+  - 2.3.0
   - rbx
 
 install: bundle install --retry=3

data/README.md

@@ -5,7 +5,7 @@
 [![Dependency Status](https://gemnasium.com/bodrovis/lessons_indexer.svg)](https://gemnasium.com/bodrovis/lessons_indexer)
 # Lessons Indexer for Sitepoint Premium
 
-Builds an index in Markdown format for the lesson files in the provided directory, adds heading images to the files, generates PDFs from Markdown, pushes changes to GitHub. Can work with multiple branches.
+Builds an index in Markdown format for the lesson files in the provided directory, adds heading images to the files, generates PDFs from Markdown, pushes changes to GitHub. Can work with multiple branches and generate an array of empty files.
 
 Relies on [messages_dictionary](https://github.com/bodrovis-learning/messages_dictionary) to store messages.
 
@@ -54,6 +54,14 @@ has a heading in the beginning, it will be skipped.
 Defaults to `headings`, has no effect if the `-i` flag is not set.
 * `-f` (`--pdf`) - should PDFs be generated from the lesson files in markdown format. PDFs will have the same name as the
 lesson files, read more [below](#pdf-generation). Defauls to `false`.
+* `-l` (`--lessons`) - accepts an array of numbers delimited with `,` (for example, `-l 1,2,3`). Each number represents a number
+of files to generate for a specific lesson. In the provided example, the first lesson contains 1 step, the second -
+2 steps, the third - 3 steps. The script will then create a bunch of appropriate files, called *lessonx-y.md*,
+where *x* is a lesson number and *y* is a step number, for example *lesson1-1.md*, *lesson2-1.md* etc, up to *lesson3-3.md*. This option
+is useful when you only begin to produce handouts for a course and need a bunch of empty files to place your text into.
+**Please note** that if this option is present, all other options (expect for the `--path`) will be ignored,
+meaning that the script won't do anything else. This is because the lesson files will be empty and
+obviously you wouldn't want to generate PDFs or push anything to GitHub at this point.
 
 ## Some Assumptions
 
@@ -64,7 +72,7 @@ the course and end with the `_handouts` (the program will do its best to convert
 be converted to "Introduction To Less").
 * Lesson files should have the lesson and step numbers in their title separated by `.` or `-`. It may contain any other
 words, but they have to have *.md* extension. Here is an example of a valid file name: `lesson3.2.md` or `h3-2.md`. All other
-files will be ignored.
+files will be ignored. Use `-l` option to generate lesson files automatically.
 * If the `-i` flag is set (to add headings to the lesson files), the `*_handouts` folder has to contain directory with the images.
 This directory's name can be provided with the `-d` flag. Files inside should follow the same naming conditions as for the lesson
 files (of course, they don't need to have the *.md* extension). Valid files names: `Git Course 1.1.jpg` or `google_maps10-3.png`.

data/lessons_indexer.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "slop", "~> 4.2"
   spec.add_dependency "facets", "~> 3.0"
   spec.add_dependency "colorize", "~> 0.7.7"
-  spec.add_dependency "messages_dictionary", "~> 0.1.0"
+  spec.add_dependency "messages_dictionary", "~> 0.1.2"
 
   spec.add_development_dependency "rake", "~> 11.1"
   spec.add_development_dependency "rspec", "~> 3.4"

data/lib/lessons_indexer/collections/base.rb

@@ -10,7 +10,7 @@ module LessonsIndexer
       end
 
       def each
-        list.map { |heading| yield heading }
+        list.map { |element| yield element }
       end
     end
   end

data/lib/lessons_indexer/course.rb

@@ -12,6 +12,16 @@ module LessonsIndexer
       @headings = []
     end
 
+    def generate_files(lessons_count)
+      within(dir, true) do
+        lessons_count.map {|l| Integer(l)}.each_with_index do |steps, lesson|
+          (1..steps).each do |step|
+            File.new("lesson#{lesson + 1}-#{step}.md", 'w+').close
+          end
+        end
+      end
+    end
+
     def generate_index
       lessons.list.sort.inject(pou('course.index_title', title: title)) do |memo, lesson|
         memo + lesson.link(dir)

data/lib/lessons_indexer/indexer.rb

@@ -12,10 +12,20 @@ module LessonsIndexer
     def do_work!
       course = Course.new(get_course_dir, options.headings_dir)
 
-      build_index(course) unless options.skip_index
-      add_headings(course) if options.headings
-      generate_pdfs(course) if options.pdf
-      git_push! if options.git
+      if options.lessons.length > 0
+        generate_files(course)
+      else
+        build_index(course) unless options.skip_index
+        add_headings(course) if options.headings
+        generate_pdfs(course) if options.pdf
+        git_push! if options.git
+      end
+    end
+
+    def generate_files(course)
+      with_messages(pou('lessons.starting'), pou('lessons.done', title: course.title)) do
+        course.generate_files(options.lessons)
+      end
     end
 
     def build_index(course)

data/lib/lessons_indexer/messages/messages.yml

@@ -1,6 +1,9 @@
 starter:
   welcome: "=== [ Welcome to Lessons Indexer ver{{version}}! ] ==="
   done: "=== [ DONE. ] ==="
+lessons:
+  starting: "Starting to generate files..."
+  done: "Lesson files for the {{title}} course are generated!"
 index:
   starting: "Starting to build index..."
   done: "Index for the {{title}} course is generated!"
@@ -30,4 +33,5 @@ options:
   all: 'Work with all branches (except for master)'
   headings: 'Add heading images to the beginning of the lesson files?'
   headings_dir: 'Relative path to the directory with heading images'
-  pdf: 'Should PDFs be generated?'
+  pdf: 'Should PDFs be generated?'
+  lessons: 'Lessons'

data/lib/lessons_indexer/options.rb

@@ -26,6 +26,7 @@ module LessonsIndexer
           o.bool '-i', '--headings', pou('options.headings'), default: false
           o.string '-d', '--headings_dir', pou('options.headings_dir'), default: pou('options.default.headings_dir')
           o.bool '-f', '--pdf', pou('options.pdf'), default: false
+          o.array '-l', '--lessons', pou('options.lessons'), default: []
           o.on '--help' do
             puts o
             exit

data/lib/lessons_indexer/version.rb

@@ -1,3 +1,3 @@
 module LessonsIndexer
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/spec/course_spec.rb

@@ -26,6 +26,10 @@ RSpec.describe LessonsIndexer::Course do
     expect(subject).to respond_to(:generate_pdfs)
   end
 
+  specify "#generate_files" do
+    expect(subject).to respond_to(:generate_files)
+  end
+
   context "#generate_headings" do
     it "should return formatted heading and path to file" do
       expect(subject).to receive(:lessons).and_return(sample_lessons)
@@ -54,9 +58,9 @@ RSpec.describe LessonsIndexer::Course do
   end
 
   context "file system access" do
-    before(:all) { setup_env! }
+    before(:each) { setup_env! }
 
-    after(:all) { clear_env! }
+    after(:each) { clear_env! }
 
     context "#load_headings!" do
       let(:headings) {subject.load_headings!}

data/spec/indexer_spec.rb

@@ -1,90 +1,134 @@
 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 "with pre-defined files" do
+    before(:all) { setup_env! }
+    after(:all) { clear_env! }
 
-  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! }
+    context "#options" do
+      it "should return output" do
+        expect(subject.options.output).to eq('test.md')
+      end
     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
+    context "#do_work!" do
+      it "should build index if --skip_index is not set", :test 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 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
+      it "should generate files if --lessons is set" do
+        allow(subject.options).to receive(:lessons).and_return([1,2])
+        expect(subject).to receive(:generate_files)
+        expect(subject).not_to receive(:add_headings)
+        expect(subject).not_to receive(:git_push!)
+        expect(subject).not_to receive(:generate_pdfs)
+        expect(subject).not_to receive(:build_index)
+        capture_stdout { subject.do_work! }
+      end
 
-    it "should generate pdfs if --pdf is set" do
-      allow(subject.options).to receive(:skip_index).and_return(true)
-      allow(subject.options).to receive(:pdf).and_return(true)
-      expect(subject).to receive(:generate_pdfs)
-      capture_stdout { subject.do_work! }
+      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
+
+      it "should generate pdfs if --pdf is set" do
+        allow(subject.options).to receive(:skip_index).and_return(true)
+        allow(subject.options).to receive(:pdf).and_return(true)
+        expect(subject).to receive(:generate_pdfs)
+        capture_stdout { subject.do_work! }
+      end
     end
-  end
 
-  context "#get_course_dir" do
-    it "should return course dir" do
-      expect(subject.get_course_dir).to eq('my_course_handouts')
+    context "#get_course_dir" do
+      it "should return course dir" do
+        expect(subject.get_course_dir).to eq('my_course_handouts')
+      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
 
-    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)
+    context "#generate_pdfs" do
+      it "should display proper messages" do
+        expect(course).to receive(:load_lessons!)
+        expect(course).to receive(:generate_pdfs)
+        info = capture_stdout do
+          subject.generate_pdfs(course)
         end.uncolorize
-        expect(err).to eq("[ERROR] Lesson files were not found inside the provided directory. Aborting...\n")
+        expect(info).to eq("Starting to generate PDFs...\nPDFs for the course My Course were generated!\n#{'=' * 50}\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")
+    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
 
-    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")
+    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
 
-  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
+  context "with clear directory" do
+    before(:all) { setup_env!(true) }
+    after(:all) { clear_env! }
 
-    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")
+    context "#generate_files" do
+      it "should display proper info messages" do
+        info = capture_stdout do
+          subject.generate_files(course)
+        end.uncolorize
+        expect(info).to eq("Starting to generate files...\nLesson files for the My Course course are generated!\n#{'=' * 50}\n")
+      end
+
+      it "should generate proper files" do
+        allow(subject.options).to receive(:lessons).and_return([1,2])
+        capture_stdout { subject.generate_files(course) }
+        expect(Dir.entries('my_course_handouts')).to include('lesson1-1.md', 'lesson2-1.md', 'lesson2-2.md')
+        expect(Dir.entries('my_course_handouts')).not_to include('lesson3-1.md', 'lesson2-3.md')
+      end
     end
   end
 end

data/spec/options_spec.rb

@@ -10,10 +10,19 @@ RSpec.describe LessonsIndexer::Options do
     expect(options.headings).to be_falsey
     expect(options.headings_dir).to eq('headings')
     expect(options.pdf).to be_falsey
+    expect(options.lessons).to eq([])
+    expect(options).not_to respond_to(:help)
+  end
+
+  it "should raise an error if an unknown option is passed" do
+    err = capture_stderr do
+      expect( -> {described_class.new(['-u', 'test'])} ).to raise_error(SystemExit)
+    end.uncolorize
+    expect(err).to eq("[ERROR] unknown option `-u'\n")
   end
 
   it "should allow to override some options" do
-    argv = ['-p', 'test_path', '-g', '-o', 'test.md']
+    argv = ['-p', 'test_path', '-g', '-o', 'test.md', '-l', '1,2,3']
     options = described_class.new(argv)
     expect(options.path).to eq('test_path')
     expect(options.output).to eq('test.md')
@@ -21,5 +30,6 @@ RSpec.describe LessonsIndexer::Options do
     expect(options.message).to eq('Added index')
     expect(options.all).to be_falsey
     expect(options.headings).to be_falsey
+    expect(options.lessons.length).to eq(3)
   end
 end

data/spec/support/spec_files_setup.rb

@@ -1,19 +1,21 @@
 require 'fileutils'
 
 module SpecFilesSetup
-  def setup_env!
+  def setup_env!(empty = false)
     FileUtils.mkdir_p('my_course_handouts/headings')
-    lessons_array_with_incorrect.each do |file|
-      File.new("my_course_handouts/#{file}", 'w+').close
-    end
+    unless empty
+      lessons_array_with_incorrect.each do |file|
+        File.new("my_course_handouts/#{file}", 'w+').close
+      end
 
-    headings_array_with_incorrect.each do |file|
-      File.new("my_course_handouts/headings/#{file}", 'w+').close
+      headings_array_with_incorrect.each do |file|
+        File.new("my_course_handouts/headings/#{file}", 'w+').close
+      end
     end
   end
 
   def clear_env!
-    FileUtils.remove_entry('my_course_handouts')
+    FileUtils.remove_entry('my_course_handouts', true)
     FileUtils.remove_entry('test.md', true)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lessons_indexer
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-09 00:00:00.000000000 Z
+date: 2016-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement