lessons_indexer 0.0.2.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 700b6b45e2dcbff289222f9c44f1eaea2fcb9997
-  data.tar.gz: 156538d022744cc4520352f90ca375e76266a288
+  metadata.gz: a7243e7160db8957d476986d9f39a7798a37f2b2
+  data.tar.gz: 99309f57fe10c2a1553d70f44d61a35626fd4a7d
 SHA512:
-  metadata.gz: e6dec8a959a6ab12f203001e164ffd0cf3836bc090c64853078fa18c9417dab332d6c2fbb4629111128ad01fb794b4cfe0dfb1a62f1fb7df1e8b4b157ee9cd20
-  data.tar.gz: 02fae34b5d7415b1b8d4a476e873b49e5132cf4224af35966fb0e34304e919a938ff0b8ff08cf2c3eea904bee706388bda5ecba26b7cde854c7feedcf0c80e3e
+  metadata.gz: 5e903f04e4067dd895c6d0883d0b8494b5c6e195f63f1bb71b82231a93b5f2a57145e8b23443ce81577d3ad3a71c14ef85445e5cfb805ecc0edf44c62483e777
+  data.tar.gz: aaeeed24149cc80a1382a2817bdadf12b07e97600512423a9f183dfd4be39b2fbd61f8f8eeba86ff41c4179724f083ea0d5910c5529dd71121837f59f73a86d8

data/.rspec

@@ -1 +1 @@
---color --format doc --order rand  --require spec_helper
+--color --format doc --order rand --require spec_helper

data/.travis.yml

@@ -10,4 +10,4 @@ install: bundle install --retry=3
 
 addons:
   code_climate:
-    repo_token: df97d1d00135276a49d16e84df69eaa77e6cf3e9cd27c3e165b32524eee567cf
+    repo_token: 130f102bb847552a17b84646d50dba4809adf2af84aff06d8413dbe4d79ce8c0

data/README.md

@@ -1,7 +1,8 @@
-[![Build Status](https://travis-ci.org/bodrovis/LessonsIndexer.svg?branch=master)](https://travis-ci.org/bodrovis/LessonsIndexer)
-[![Code Climate](https://codeclimate.com/github/bodrovis/LessonsIndexer/badges/gpa.svg)](https://codeclimate.com/github/bodrovis/LessonsIndexer)
-[![Test Coverage](https://codeclimate.com/github/bodrovis/LessonsIndexer/badges/coverage.svg)](https://codeclimate.com/github/bodrovis/LessonsIndexer/coverage)
-[![Dependency Status](https://gemnasium.com/bodrovis/LessonsIndexer.svg)](https://gemnasium.com/bodrovis/LessonsIndexer)
+[![Gem Version](https://badge.fury.io/rb/lessons_indexer.svg)](http://badge.fury.io/rb/lessons_indexer)
+[![Build Status](https://travis-ci.org/bodrovis/lessons_indexer.svg?branch=master)](https://travis-ci.org/bodrovis/lessons_indexer)
+[![Code Climate](https://codeclimate.com/github/bodrovis/lessons_indexer/badges/gpa.svg)](https://codeclimate.com/github/bodrovis/lessons_indexer)
+[![Test Coverage](https://codeclimate.com/github/bodrovis/lessons_indexer/badges/coverage.svg)](https://codeclimate.com/github/bodrovis/lessons_indexer/coverage)
+[![Dependency Status](https://gemnasium.com/bodrovis/lessons_indexer.svg)](https://gemnasium.com/bodrovis/lessons_indexer)
 # Lessons Indexer for Learnable
 
 Builds an index in Markdown format for the lesson files in the provided directory, adds heading images to the files,
@@ -49,7 +50,7 @@ is not set.
 * `-i` (`--headings`) - if present, heading images will be added to the beginning of each lesson file. If the file already
 has a heading in the beginning, it will be skipped.
 * `-d` (`--headings_dir`) - relative path to the directory with heading images.
-Defaults to `headers`, has no effect if the `-i` flag is not set.
+Defaults to `headings`, has no effect if the `-i` flag is not set.
 
 ## Some Assumptions
 

data/lessons_indexer.gemspec

@@ -19,8 +19,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "facets", "~> 3.0"
   spec.add_dependency "colorize", "~> 0.7.7"
 
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
 end

data/lib/lessons_indexer.rb

@@ -2,14 +2,23 @@ require 'facets/string/titlecase'
 require 'slop'
 require 'colorize'
 
-require 'lessons_indexer/version'
-require 'lessons_indexer/starter'
-require 'lessons_indexer/indexer'
-require 'lessons_indexer/options'
-require 'lessons_indexer/course'
 require 'lessons_indexer/addons/file_manager'
 require 'lessons_indexer/addons/git_manager'
 require 'lessons_indexer/addons/utils'
 
+require 'lessons_indexer/models/base'
+require 'lessons_indexer/models/heading'
+require 'lessons_indexer/models/lesson'
+
+require 'lessons_indexer/collections/base'
+require 'lessons_indexer/collections/headings_list'
+require 'lessons_indexer/collections/lessons_list'
+
+require 'lessons_indexer/version'
+require 'lessons_indexer/options'
+require 'lessons_indexer/course'
+require 'lessons_indexer/indexer'
+require 'lessons_indexer/starter'
+
 module LessonsIndexer
 end

data/lib/lessons_indexer/addons/file_manager.rb

@@ -1,28 +1,33 @@
 module LessonsIndexer
-  class Writer
-    attr_reader :name
+  module Addons
+    module FileManager
+      class Writer
+        attr_reader :name
 
-    def initialize(name)
-      @name = name
-    end
+        def initialize(name)
+          @name = name
+        end
 
-    def prepend_data(data)
-      begin
-        old_data = File.read(name)
-      rescue StandardError => e
-        warning e.message
-      end
-      unless old_data.start_with?(data)
-        new_data = old_data.prepend(data)
-        self << new_data
-      end
-    end
+        def prepend_data(data)
+          begin
+            old_data = File.read(name)
+          rescue StandardError => e
+            warning `ls`
+            warning e.message
+          end
+          unless old_data.start_with?(data)
+            new_data = old_data.prepend(data)
+            self << new_data
+          end
+        end
 
-    def <<(*args)
-      begin
-        File.open(name, 'w+') { |f| f.write(args.join) }
-      rescue StandardError => e
-        warning e.message
+        def <<(*args)
+          begin
+            File.open(name, 'w+') { |f| f.write(args.join) }
+          rescue StandardError => e
+            warning e.message
+          end
+        end
       end
     end
   end

data/lib/lessons_indexer/addons/git_manager.rb

@@ -1,34 +1,36 @@
 module LessonsIndexer
-  module GitManager
-    class Pusher
-      attr_reader :message
+  module Addons
+    module GitManager
+      class Pusher
+        attr_reader :message
 
-      def initialize(message)
-        @message = message
-      end
+        def initialize(message)
+          @message = message
+        end
 
-      def push!
-        %x{git add .}
-        %x{git commit -am "#{message}"}
-        %x{git push origin HEAD}
+        def push!
+          %x{git add .}
+          %x{git commit -am "#{message}"}
+          %x{git push origin HEAD}
+        end
       end
-    end
 
-    class Brancher
-      attr_reader :ignore_master
+      class Brancher
+        attr_reader :ignore_master
 
-      def initialize(ignore_master = true)
-        @ignore_master = ignore_master
-      end
+        def initialize(ignore_master = true)
+          @ignore_master = ignore_master
+        end
 
-      def get_branches
-        branches = %x{git branch}.split("\n").map {|br| br.strip.gsub(/\A\*\s*/, '') }
-        ignore_master ? branches.reject {|el| el == 'master'} : branches
-      end
+        def get_branches
+          branches = %x{git branch}.split("\n").map {|br| br.strip.gsub(/\A\*\s*/, '') }
+          ignore_master ? branches.reject {|el| el == 'master'} : branches
+        end
 
-      def within_branch(branch)
-        %x{git checkout #{branch} --force}
-        yield if block_given?
+        def within_branch(branch)
+          %x{git checkout #{branch} --force}
+          yield if block_given?
+        end
       end
     end
   end

data/lib/lessons_indexer/collections/base.rb

@@ -0,0 +1,17 @@
+module LessonsIndexer
+  module Collections
+    class Base
+      include Enumerable
+
+      attr_reader :list
+
+      def initialize(list)
+        @list = list
+      end
+
+      def each
+        list.map { |heading| yield heading }
+      end
+    end
+  end
+end

data/lib/lessons_indexer/collections/headings_list.rb

@@ -0,0 +1,11 @@
+module LessonsIndexer
+  module Collections
+    class HeadingsList < Base
+      def for(lesson)
+        detect do |heading|
+          lesson.major == heading.major && lesson.minor == heading.minor
+        end
+      end
+    end
+  end
+end

data/lib/lessons_indexer/collections/lessons_list.rb

@@ -0,0 +1,6 @@
+module LessonsIndexer
+  module Collections
+    class LessonsList < Base
+    end
+  end
+end

data/lib/lessons_indexer/course.rb

@@ -1,32 +1,50 @@
 module LessonsIndexer
   class Course
-    STEP_LESSON_PATTERN = /(\d+)(?:\.|-)(\d+)/
+    include Models
+    include Collections
 
-    attr_reader :dir, :title, :lessons
+    attr_reader :dir, :headings_dir, :title, :lessons, :headings
 
-    def initialize(course_dir)
+    def initialize(course_dir, headings_dir)
       @dir = course_dir
+      @headings_dir = headings_dir
       @title = dir.gsub(/_handouts\z/i, '').titlecase
-      @lessons = get_lessons
+      @headings = []
     end
 
-    def get_lessons
-      #TODO: Lesson class
-      within(dir, true) do
-        Dir.entries('.').keep_if {|f| f =~ /\.md\z/i }.sort do |a, b|
-          begin
-            step_a, step_b = a.match(STEP_LESSON_PATTERN), b.match(STEP_LESSON_PATTERN)
-            major_a, minor_a, major_b, minor_b = step_a[1].to_i, step_a[2].to_i, step_b[1].to_i, step_b[2].to_i
-            if major_a == major_b
-              minor_a <=> minor_b
-            else
-              major_a <=> major_b
-            end
-          rescue NoMethodError
-            warning "Found the #{lesson} file which does not have proper naming. File name should contain lesson and step, for example: 'lesson3.2.md'. Skipping this file."
-          end
+    def generate_index
+      lessons.list.sort.inject("# Index for the " + title + " course\n\n") do |memo, lesson|
+        memo + lesson.link(dir)
+      end
+    end
+
+    def generate_headings
+      lessons.each do |lesson|
+        lesson_heading = headings.for(lesson)
+        if lesson_heading
+          yield "![](#{headings_dir}/#{lesson_heading.file_name})\n\n", lesson.path
+        else
+          warning "I was not able to find heading image for the #{lesson.name}"
         end
       end
     end
+
+    def load_headings!
+      within(dir + '/' + headings_dir, true) do
+        @headings = HeadingsList.new(all_with_pattern(Heading::VERSION_PATTERN).map {|heading| Heading.new(heading)})
+      end
+    end
+
+    def load_lessons!
+      within(dir, true) do
+        @lessons = LessonsList.new(all_with_pattern(Lesson::NAME_PATTERN).map {|lesson| Lesson.new(lesson)})
+      end
+    end
+
+    private
+
+    def all_with_pattern(pattern)
+      Dir.entries('.').keep_if {|f| f =~ pattern }
+    end
   end
 end

data/lib/lessons_indexer/indexer.rb

@@ -1,6 +1,7 @@
 module LessonsIndexer
   class Indexer
-    STEP_LESSON_PATTERN = /(\d+)(?:\.|-)(\d+)/
+    include Addons::FileManager
+    include Addons::GitManager
 
     attr_reader :options
 
@@ -8,88 +9,36 @@ module LessonsIndexer
       @options = options
     end
 
-    def build_index!
-      course = Course.new(get_dir_name)
-      with_messages("Starting to build index...", "Index for the #{course.title} course is generated!") do
-        generate_index_for course
-      end
-    end
+    def do_work!
+      course = Course.new(get_course_dir, options.headings_dir)
 
-    def add_headings!
-      with_messages("Starting to add headings...", "Headings for the lesson files were added!") do
-        course = Course.new(get_dir_name)
-        within(course.dir, true) do
-          generate_headings_for course
-        end
-      end
+      build_index(course) unless options.skip_index
+      add_headings(course) if options.headings
+      git_push! if options.git
     end
 
-    private
-
-    def generate_headings_for(course)
-      images = within(options.headings_dir, true) { get_files }.keep_if {|f| f.match(STEP_LESSON_PATTERN)}
-
-      course.lessons.each do |lesson_file|
-        step_lesson = lesson_file.match(STEP_LESSON_PATTERN)
-        begin
-          lesson_image = images.detect do |image|
-            step_image = image.match(STEP_LESSON_PATTERN)
-            step_lesson[1] == step_image[1] && step_lesson[2] == step_image[2]
-          end
-          if lesson_image
-            prepend!("![](#{options.headings_dir}/#{lesson_image})\n\n", lesson_file)
-          else
-            warning "I was not able to find heading image for the lesson #{step_lesson[0]}"
-          end
-        rescue NoMethodError
-          warning "Found the #{lesson_file} file which does not have proper naming. File name should contain lesson and step, for example: 'lesson3.2.md'. Skipping this file."
-        end
+    def build_index(course)
+      course.load_lessons!
+      with_messages("Starting to build index...", "Index for the #{course.title} course is generated!") do
+        write! course.generate_index, options.output
       end
     end
 
-    def generate_index_for(course)
-      write!(
-        course.lessons.inject("# Index for the " + course.title + " course\n\n") do |memo, lesson|
-          memo + display_lesson_link(lesson, course.dir)
-        end, options.output
-      )
-    end
-
-    def display_lesson_link(lesson, dir)
-      step = lesson.match(STEP_LESSON_PATTERN)
-      begin
-        "* [Lesson #{step[1]}.#{step[2]}](#{dir}/#{lesson})\n"
-      rescue NoMethodError
-        warning "Found the #{lesson} file which does not have proper naming. File name should contain lesson and step, for example: 'lesson3.2.md'. Skipping this file."
-        return ''
+    def add_headings(course)
+      course.load_lessons!
+      course.load_headings!
+      with_messages("Starting to add headings...", "Headings for the lesson files of #{course.title} course were added!") do
+        course.generate_headings { |heading_line, lesson_file| prepend!(heading_line, lesson_file) }
       end
     end
 
-    def get_dir_name
-      dir = get_files.detect {|el| el =~ /_handouts\z/i}
+    def get_course_dir
+      dir = Dir.entries('.').detect {|el| el =~ /_handouts\z/i}
       exit_msg("Lesson files were not found inside the provided directory. Aborting...") if dir.nil?
       dir
     end
 
-    def get_files
-      Dir.entries('.').delete_if {|f| f == '.' || f == '..' || f == '.git' || f == '.gitignore' }
-    end
-
-    def get_lessons
-      Dir.entries('.').keep_if {|f| f =~ /\.md\z/i }.sort do |a, b|
-        begin
-          step_a, step_b = a.match(STEP_LESSON_PATTERN), b.match(STEP_LESSON_PATTERN)
-          major_a, minor_a, major_b, minor_b = step_a[1].to_i, step_a[2].to_i, step_b[1].to_i, step_b[2].to_i
-          if major_a == major_b
-            minor_a <=> minor_b
-          else
-            major_a <=> major_b
-          end
-        rescue NoMethodError
-          warning "Found the #{lesson} file which does not have proper naming. File name should contain lesson and step, for example: 'lesson3.2.md'. Skipping this file."
-        end
-      end
-    end
+    private
 
     def write!(contents, file)
       writer = Writer.new(file)
@@ -100,5 +49,10 @@ module LessonsIndexer
       writer = Writer.new(file)
       writer.prepend_data(contents)
     end
+
+    def git_push!
+      pusher = Pusher.new(options.message)
+      pusher.push!
+    end
   end
 end

data/lib/lessons_indexer/models/base.rb

@@ -0,0 +1,25 @@
+module LessonsIndexer
+  module Models
+    class Base
+      include Comparable
+
+      VERSION_PATTERN = /(?<minor_major>(?<major>(\d+))(?:\.|-)(?<minor>(\d+)))/i
+      attr_reader :file_name, :major, :minor, :path
+
+      def initialize(file_name)
+        @file_name = file_name
+        @path = File.expand_path(file_name)
+        @major = file_name.match(VERSION_PATTERN)[:major].to_i
+        @minor = file_name.match(VERSION_PATTERN)[:minor].to_i
+      end
+
+      def <=>(other)
+        if self.major == other.major
+          self.minor <=> other.minor
+        else
+          self.major <=> other.major
+        end
+      end
+    end
+  end
+end