lessons_indexer 1.0.2.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 875c2a5a410834e123e1bd10d87ca630a2a5d73f
-  data.tar.gz: 7b5408276a3c2bed09c66dbf413d1ea9adbcbd37
+  metadata.gz: 9cf9dd26d4596d4b4fe904c7e1cfa6989a89de64
+  data.tar.gz: b6e93014db8823c91920027df9a5c2884554a3ec
 SHA512:
-  metadata.gz: 6cf4f68add5f678202cdbb6871c0648f2dcbc2737dda471ace33f3e8f3510c17b361943fc9274b3f1ca85543f975e1664f2a28152bf290cb0d8039df30791c31
-  data.tar.gz: 9393ccb291bb416d03344ac77a51c2204718d33866848be498c73acb8450bb430012220777fff7af52299c58d320be3e6e5fbe026f29652e96172a565a2c66af
+  metadata.gz: 98cffc5c91e39187dfc5cde41e3a18b76d4709d8a69d781f0e058082a4fa8de141f47a00256b1641d9fdbfe6b02b11f18937e8c2a4664e71dec6cdaa9c802785
+  data.tar.gz: 4407bfebba3ec618c353d92db5c817e03313d6fe22b09e964a8cc3f79223eed71725e7ba52b67e2b6d4cb5a1e6388a777dd420c5d38b8a0bc0c5fdaf08ca6615

data/README.md

@@ -7,6 +7,8 @@
 
 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.
 
+Relies on [messages_dictionary](https://github.com/bodrovis-learning/messages_dictionary) to store messages.
+
 ## Installation and Usage
 
 Requires [Ruby](https://www.ruby-lang.org) 2.0+ and [RubyGems](https://rubygems.org/). `Ruby\bin` should be added

data/lessons_indexer.gemspec

@@ -20,6 +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_development_dependency "rake", "~> 11.1"
   spec.add_development_dependency "rspec", "~> 3.4"

data/lib/lessons_indexer/course.rb

@@ -1,5 +1,5 @@
 module LessonsIndexer
-  class Course
+  class Course < Messenger
     include Models
     include Collections
 
@@ -13,7 +13,7 @@ module LessonsIndexer
     end
 
     def generate_index
-      lessons.list.sort.inject("# Index for the " + title + " course\n\n") do |memo, lesson|
+      lessons.list.sort.inject(pou('course.index_title', title: title)) do |memo, lesson|
         memo + lesson.link(dir)
       end
     end
@@ -24,7 +24,7 @@ module LessonsIndexer
         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}"
+          warning pou('warnings.heading_not_found', lesson: lesson.name)
         end
       end
     end

data/lib/lessons_indexer/indexer.rb

@@ -1,5 +1,5 @@
 module LessonsIndexer
-  class Indexer
+  class Indexer < Messenger
     include Addons::FileManager
     include Addons::GitManager
 
@@ -20,7 +20,7 @@ module LessonsIndexer
 
     def build_index(course)
       course.load_lessons!
-      with_messages("Starting to build index...", "Index for the #{course.title} course is generated!") do
+      with_messages(pou('index.starting'), pou('index.done', title: course.title)) do
         write! course.generate_index, options.output
       end
     end
@@ -28,21 +28,21 @@ module LessonsIndexer
     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
+      with_messages(pou('heading.starting'), pou('heading.done', title: course.title)) do
         course.generate_headings { |heading_line, lesson_file| prepend!(heading_line, lesson_file) }
       end
     end
 
     def generate_pdfs(course)
       course.load_lessons!
-      with_messages("Starting to generate PDFs...", "PDFs for the course #{course.title} were generated!") do
+      with_messages(pou('pdf.starting'), pou('pdf.done', title: course.title)) do
         course.generate_pdfs
       end
     end
 
     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?
+      exit_msg(pou('errors.files_not_found')) if dir.nil?
       dir
     end
 

data/lib/lessons_indexer/messages/messages.yml

@@ -0,0 +1,33 @@
+starter:
+  welcome: "=== [ Welcome to Lessons Indexer ver{{version}}! ] ==="
+  done: "=== [ DONE. ] ==="
+index:
+  starting: "Starting to build index..."
+  done: "Index for the {{title}} course is generated!"
+course:
+  index_title: "# Index for the {{title}} course\n\n"
+heading:
+  starting: "Starting to add headings..."
+  done: "Headings for the lesson files of {{title}} course were added!"
+pdf:
+  starting: "Starting to generate PDFs..."
+  done: "PDFs for the course {{title}} were generated!"
+warnings:
+  heading_not_found: "I was not able to find heading image for the {{lesson}}"
+errors:
+  files_not_found: "Lesson files were not found inside the provided directory. Aborting..."
+options:
+  default:
+    path: '.'
+    output: 'README.md'
+    message: 'Added index'
+    headings_dir: 'headings'
+  path: 'Path to the directory with the course'
+  skip_index: 'Skip index generation for the course'
+  output: 'Output file'
+  git: 'Push changes to the remote Git branch?'
+  message: 'Commit message'
+  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?'

data/lib/lessons_indexer/options.rb

@@ -1,5 +1,5 @@
 module LessonsIndexer
-  class Options
+  class Options < Messenger
     def initialize(argv)
       parse_args(argv).each do |k, v|
         # attr_accessor for each possible option
@@ -17,15 +17,15 @@ module LessonsIndexer
     def parse_args(argv)
       begin
         Slop.parse argv do |o|
-          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'
-          o.bool '-g', '--git', 'Push changes to the remote Git branch?', default: false
-          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: 'headings'
-          o.bool '-f', '--pdf', 'Should PDFs be generated?', default: false
+          o.string '-p', '--path', pou('options.path'), default: pou('options.default.path')
+          o.bool '-s', '--skip_index', pou('options.skip_index'), default: false
+          o.string '-o', '--output', pou('options.output'), default: pou('options.default.output')
+          o.bool '-g', '--git', pou('options.git'), default: false
+          o.string '-m', '--message', pou('options.message'), default: pou('options.default.message')
+          o.bool '-a', '--all', pou('options.all'), default: false
+          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.on '--help' do
             puts o
             exit

data/lib/lessons_indexer/starter.rb

@@ -1,5 +1,5 @@
 module LessonsIndexer
-  class Starter
+  class Starter < Messenger
     attr_reader :options
 
     def initialize(argv)
@@ -7,7 +7,7 @@ module LessonsIndexer
     end
 
     def start!
-      with_messages("=== [ Welcome to Lessons Indexer ver#{LessonsIndexer::VERSION}! ] ===", "=== [ DONE. ] ===", false) do
+      with_messages(pou('starter.welcome', version: LessonsIndexer::VERSION), pou('starter.done'), false) do
         indexer = Indexer.new(options)
 
         within options.path do

data/lib/lessons_indexer/version.rb

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

data/lib/lessons_indexer.rb

@@ -1,6 +1,16 @@
 require 'facets/string/titlecase'
 require 'slop'
 require 'colorize'
+require 'messages_dictionary'
+
+module LessonsIndexer
+  class Messenger
+    include MessagesDictionary
+    has_messages_dictionary file: 'messages.yml',
+                            dir: 'lib/lessons_indexer/messages',
+                            transform: ->(msg) {msg}
+  end
+end
 
 require 'lessons_indexer/addons/file_manager'
 require 'lessons_indexer/addons/git_manager'
@@ -18,7 +28,4 @@ require 'lessons_indexer/version'
 require 'lessons_indexer/options'
 require 'lessons_indexer/course'
 require 'lessons_indexer/indexer'
-require 'lessons_indexer/starter'
-
-module LessonsIndexer
-end
+require 'lessons_indexer/starter'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lessons_indexer
 version: !ruby/object:Gem::Version
-  version: 1.0.2.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2016-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.7
+- !ruby/object:Gem::Dependency
+  name: messages_dictionary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,7 @@ files:
 - lib/lessons_indexer/collections/lessons_list.rb
 - lib/lessons_indexer/course.rb
 - lib/lessons_indexer/indexer.rb
+- lib/lessons_indexer/messages/messages.yml
 - lib/lessons_indexer/models/base.rb
 - lib/lessons_indexer/models/heading.rb
 - lib/lessons_indexer/models/lesson.rb
@@ -177,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.1
+rubygems_version: 2.6.3
 signing_key: 
 specification_version: 4
 summary: Lessons Indexer for Learnable