hs-cli 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40072df5da387c7cfd1ccdc4e5fded11d0667ced276d450edb99f4a648f8f9e1
-  data.tar.gz: 8dfdca544def1246b7dabbe03ffa4c0fa4152d541c64300bfc92a96ba791594e
+  metadata.gz: 01dbde2079037eab73a7d0380810276f614fb6c6ea4dfbb607027f1261458c78
+  data.tar.gz: 375508cdfd0574107d515b080dcbe556084f4ad324ce59a586701e90266432a7
 SHA512:
-  metadata.gz: a6061d9663674352d7e48825413e654d54e995a07db4f4b5ae1b70b6ac10987704ac28de4cfdd5616ce0505d046f25c5bdbbbe1f869f1a4882ace184c2a32ed0
-  data.tar.gz: e572c9d98d09f2a630c0566a00876796d6d116f925fe514a0310fc5144158718a301b75bb8ab6760524e2d809b1226258192cc687ceec72b5acd5449625a4a49
+  metadata.gz: a6117a1462bc5a5f1e1ed1c2f7a708d8edd3054bde127b60cbb4db9340dddc7ceec0e2c81804435b15a2dc51c118cca57085fd0bedf3819121d54ae24ad019c5
+  data.tar.gz: 21b5cb8b8d1dd4b8e10f2997dd4c67175cc85cc403da8f25af4a35ec6995c51a5ef2a20c6cacdd3bbd1edab2589373b542ddd546ba91237c046e7a2fa1af73a9

data/.hs.yml

@@ -1,2 +1 @@
 publish_url: http://hackerschool.ge
-preview_dir: previews

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hs-cli (0.2.2)
+    hs-cli (0.3.0)
       activesupport (~> 5.2)
       nokogiri (~> 1.8)
       rack-contrib (~> 2.0)

data/app/views/_nav.erb

@@ -1,13 +1,24 @@
+<% mod = defined?(mod) ? mod : nil %>
+
 <hr />
 
 <div class="uk-container">
   <ul class="uk-breadcrumb">
     <li>
-      <a href="/"><%= course %></a>
-    </li>
-    <li>
-      <span><%= chapter %></span>
+      <a href="/"><%= course.title %></a>
     </li>
+    <% if mod.nil? %>
+      <li>
+        <span><%= chapter.title %></span>
+      </li>
+    <% else %>
+      <li>
+        <a href="/<%= chapter.slug %>"><%= chapter.title %></a>
+      </li>
+      <li>
+        <span><%= mod.title %></span>
+      </li>
+    <% end %>
   </ul>
 </div>
 

data/app/views/chapter.erb

@@ -9,13 +9,33 @@
     </p>
   </div>
 
-  <%= erb :_nav, layout: false, locals: { course: @course.title, chapter: @chapter.title } %>
+  <%= erb :_nav, layout: false, locals: { course: @course, chapter: @chapter } %>
 
   <div class="uk-container">
     <%= @chapter.preview %>
   </div>
 
-  <%= erb :_nav, layout: false, locals: { course: @course.title, chapter: @chapter.title } %>
+  <% unless @chapter.modules.empty? %>
+    <div class="uk-container">
+      <h2 class="toc-title">
+        <span uk-icon="icon: list"></span>
+        თავის შინაარსი
+      </h2>
+
+      <ol class="toc">
+        <% @chapter.modules.each do |mod| %>
+          <li>
+            <a href="/<%= @chapter.slug %>/<%= mod.slug %>" class="uk-text-<%= mod.review_color %>">
+              <span uk-icon="icon: <%= mod.review_icon %>"></span>
+              <%= mod.title %>
+            </a>
+          </li>
+        <% end %>
+      </ol>
+    </div>
+  <% end %>
+
+  <%= erb :_nav, layout: false, locals: { course: @course, chapter: @chapter } %>
 
   <%= erb :_footer, layout: false %>
 </div>

data/app/views/course.erb

@@ -9,6 +9,7 @@
 
   <div class="uk-container">
     <h2 class="toc-title">
+      <span uk-icon="icon: list"></span>
       კურსის შინაარსი
     </h2>
 

data/app/views/module.erb

@@ -0,0 +1,21 @@
+<div class="uk-section">
+  <div class="uk-container">
+    <h1>
+      <%= @module.title %>
+    </h1>
+    <p class="uk-text-<%= @module.review_color %>">
+      <span uk-icon="icon: <%= @module.review_icon %>"></span>
+      <%= @module.review_title %>
+    </p>
+  </div>
+
+  <%= erb :_nav, layout: false, locals: { course: @course, chapter: @chapter, mod: @module } %>
+
+  <div class="uk-container">
+    <%= @module.preview %>
+  </div>
+
+  <%= erb :_nav, layout: false, locals: { course: @course, chapter: @chapter, mod: @module } %>
+
+  <%= erb :_footer, layout: false %>
+</div>

data/lib/hs/config.rb

@@ -8,16 +8,11 @@ module HS
     include Singleton
 
     DEFAULT_BASE_URL = 'http://hackerschool.ge'
-    DEFAULT_PREVIEW_DIR = 'previews'
 
     def self.publish_url
       instance.publish_url
     end
 
-    def self.preview_dir
-      instance.preview_dir
-    end
-
     def initialize
       @data = load_configuration
     end
@@ -26,10 +21,6 @@ module HS
       @data['publish_url'] || DEFAULT_BASE_URL
     end
 
-    def preview_dir
-      @data['preview_dir'] || DEFAULT_PREVIEW_DIR
-    end
-
     private
 
     def load_configuration

data/lib/hs/devserver.rb

@@ -13,6 +13,7 @@ module HS
         self.app = initialize_application(config)
         set_root_route
         set_chapter_route
+        set_module_route
         app
       end
 
@@ -50,14 +51,27 @@ module HS
       def set_chapter_route
         entry = self.entry
 
-        app.get '/:slug' do
+        app.get '/:chapter' do
           @course = HS::Course.load(entry)
-          @chapter = @course.find_chapter(params[:slug])
+          @chapter = @course.find_chapter(params[:chapter])
           @title = @chapter.title
 
           erb :chapter
         end
       end
+
+      def set_module_route
+        entry = self.entry
+
+        app.get '/:chapter/:module' do
+          @course = HS::Course.load(entry)
+          @chapter = @course.find_chapter(params[:chapter])
+          @module = @chapter.find_module(params[:module])
+          @title = @module.title
+
+          erb :module
+        end
+      end
     end
   end
 end

data/lib/hs/loaders/chapter_loader.rb

@@ -8,35 +8,41 @@ module HS
     include HS::XMLParser
     include HS::ElementLoader
 
-    def load_chapter(course, xml)
-      create_chapter(course, parse_xml(xml))
+    CUSTOM_LOADERS = %i[title intro modules].freeze
+
+    def load_chapter(course, xml, &block)
+      create_chapter(course, parse_xml(xml), &block)
     end
 
     private
 
-    def create_chapter(course, data) # rubocop:disable Metrics/MethodLength
-      chapter = HS::Chapter.new(
-        course,
-        slug: data[:slug],
-        review_status: data[:review_status]
-      )
-
-      data[:_children].each do |child|
-        case child[:_name]
-        when :title
-          chapter.title = get_text(child)
-        when :intro
-          chapter.intro = load_element(child)
-        when :modules
-          # TODO: extract :modules
-          nil
-        else
-          element = load_element(child)
-          chapter.content << element if element
-        end
+    def create_chapter(course, data, &block)
+      chapter = HS::Chapter.new(course, data.slice(:slug, :review_status))
+      data[:_children].each { |child| load_a_part(chapter, child, &block) }
+      chapter
+    end
+
+    def load_a_part(chapter, child, &block)
+      if CUSTOM_LOADERS.include?(child[:_name])
+        send("load_#{child[:_name]}", chapter, child, &block)
+      else
+        element = load_element(child)
+        chapter.content << element if element
       end
+    end
 
-      chapter
+    def load_title(chapter, child)
+      chapter.title = get_text(child)
+    end
+
+    def load_intro(chapter, child)
+      chapter.intro = load_element(child)
+    end
+
+    def load_modules(chapter, child)
+      return unless block_given?
+      files = child[:_children].map { |m| m[:file] }.compact
+      files.each { |file| yield chapter, file }
     end
   end
 end

data/lib/hs/loaders/course_loader.rb

@@ -6,31 +6,33 @@ module HS
   module CourseLoader
     include HS::XMLParser
 
+    KNOWN_LOADERS = %i[title chapters].freeze
+
     def load_course(xml, &block)
       create_course(parse_xml(xml), &block)
     end
 
     private
 
-    def create_course(data) # rubocop:disable Metrics/MethodLength
-      course = HS::Course.new(slug: data[:slug])
+    def create_course(data, &block)
+      course = HS::Course.new(data.slice(:slug))
+      data[:_children].each { |child| load_a_part(course, child, &block) }
+      course
+    end
 
-      data[:_children].each do |child|
-        case child[:_name]
-        when :title
-          course.title = get_text(child)
-        when :chapters
-          if block_given?
-            files = child[:_children].map { |c| c[:file] }.compact
+    def load_a_part(course, child, &block)
+      return unless KNOWN_LOADERS.include?(child[:_name])
+      send("load_#{child[:_name]}", course, child, &block)
+    end
 
-            files.each do |file|
-              yield course, file
-            end
-          end
-        end
-      end
+    def load_title(course, child)
+      course.title = get_text(child)
+    end
 
-      course
+    def load_chapters(course, child)
+      return unless block_given?
+      files = child[:_children].map { |c| c[:file] }.compact
+      files.each { |file| yield course, file }
     end
   end
 end

data/lib/hs/loaders/module_loader.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'hs/loaders/xml_parser'
+require 'hs/loaders/element_loader'
+
+module HS
+  module ModuleLoader
+    include HS::XMLParser
+    include HS::ElementLoader
+
+    CUSTOM_LOADERS = %i[title intro].freeze
+
+    def load_module(chapter, xml)
+      create_module(chapter, parse_xml(xml))
+    end
+
+    private
+
+    def create_module(chapter, data)
+      mod = HS::Module.new(chapter, data.slice(:slug, :review_status))
+      data[:_children].each { |child| load_a_part(mod, child) }
+      mod
+    end
+
+    def load_a_part(mod, child)
+      if CUSTOM_LOADERS.include?(child[:_name])
+        send("load_#{child[:_name]}", mod, child)
+      else
+        element = load_element(child)
+        mod.content << element if element
+      end
+    end
+
+    def load_title(mod, child)
+      mod.title = get_text(child)
+    end
+
+    def load_intro(mod, child)
+      mod.intro = load_element(child)
+    end
+  end
+end

data/lib/hs/models/chapter.rb

@@ -1,37 +1,44 @@
 # frozen_string_literal: true
 
 require 'hs/loaders/chapter_loader'
-require 'hs/preview/chapter_preview'
+require 'hs/preview/content_preview'
+require 'hs/models/review_status'
 
 module HS
   class Chapter
     extend HS::ChapterLoader
-    include HS::ChapterPreview
-
-    REVIEW_STATUSES = %w[none translated first second final].freeze
+    include HS::ContentPreview
+    include HS::ReviewStatus
 
+    # Loads chapter from file.
     def self.load(course, file)
-      load_chapter(course, File.read(file))
+      dir = File.dirname(file)
+
+      load_chapter(course, File.read(file)) do |chapter, module_file|
+        path = "#{dir}/#{module_file}"
+        chapter.modules << HS::Module.load(chapter, path)
+      end
     end
 
-    attr_reader :course, :content
+    attr_reader :course, :content, :modules
     attr_accessor :slug, :title, :intro
-    attr_writer :review_status
 
     def initialize(course, args)
       @course = course
       @content = []
+      @modules = []
 
       args.each do |key, val|
         instance_variable_set("@#{key}", val)
       end
     end
 
-    def review_status
-      return 'none' unless REVIEW_STATUSES.include?(@review_status)
-      @review_status
+    # Tries to find module in this chapter by module slug.
+    def find_module(slug)
+      modules.find { |m| m.slug.to_s == slug.to_s }
     end
 
+    # URL of this chapter when published.
     def hs_url
       "#{course.hs_url}/#{slug}"
     end

data/lib/hs/models/course.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
 require 'hs/loaders/course_loader'
-require 'hs/preview/course_preview'
 
 module HS
+  # {HS::Course} is a top level model for a course.
   class Course
     extend HS::CourseLoader
-    include HS::CoursePreview
 
+    # Load course from given XML file.
     def self.load(file)
       dir = File.dirname(file)
 
@@ -21,17 +21,19 @@ module HS
     attr_reader :chapters
 
     def initialize(args)
+      @chapters = []
+
       args.each do |key, val|
         instance_variable_set("@#{key}", val)
       end
-
-      @chapters = []
     end
 
+    # Tries to find chapter in this course by chapter slug.
     def find_chapter(slug)
-      chapters.find { |c| c.slug == slug }
+      chapters.find { |c| c.slug.to_s == slug.to_s }
     end
 
+    # URL of this course when published.
     def hs_url
       "#{HS::Config.publish_url}/learn/#{slug}"
     end

data/lib/hs/models/module.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'hs/loaders/module_loader'
+require 'hs/preview/content_preview'
+require 'hs/models/review_status'
+
+module HS
+  class Module
+    extend HS::ModuleLoader
+    include HS::ContentPreview
+    include HS::ReviewStatus
+
+    attr_reader :chapter, :content
+    attr_accessor :slug, :title, :intro
+
+    def self.load(chapter, file)
+      load_module(chapter, File.read(file))
+    end
+
+    def initialize(chapter, args)
+      @chapter = chapter
+      @content = []
+
+      args.each do |key, val|
+        instance_variable_set("@#{key}", val)
+      end
+    end
+
+    # URL of this module when published.
+    def hs_url
+      "#{chapter.hs_url}/#{slug}"
+    end
+  end
+end

data/lib/hs/models/review_status.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module HS
+  module ReviewStatus
+    # Possible values for review status:
+    #
+    # - `none` not reviewed and/or not translated, needs edit or translation
+    # - `translated` initial translatation was done, needs edit
+    # - `first` first editorial review was done
+    # - `second` second editorial review was done
+    # - `final` final editorial review was done
+    REVIEW_STATUSES = %w[none translated first second final].freeze
+
+    attr_writer :review_status
+
+    def review_status
+      return 'none' unless REVIEW_STATUSES.include?(@review_status)
+      @review_status
+    end
+  end
+end

data/lib/hs/preview/content_preview.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'hs/preview/review_status_preview'
+
+module HS
+  module ContentPreview
+    include HS::ReviewStatusPreview
+
+    def preview
+      [
+        intro_preview,
+        content_preview
+      ].compact.join("\n")
+    end
+
+    private
+
+    def intro_preview
+      return unless intro
+      intro.preview
+    end
+
+    def content_preview
+      content.map(&:preview).compact.join
+    end
+  end
+end

data/lib/hs/preview/{chapter_preview.rb → review_status_preview.rb}

@@ -1,11 +1,7 @@
 # frozen_string_literal: true
 
-require 'hs/preview/html_preview'
-
 module HS
-  module ChapterPreview
-    include HS::HTMLPreview
-
+  module ReviewStatusPreview
     REVIEW_ICON = {
       none: 'file',
       translated: 'bookmark',
@@ -30,10 +26,6 @@ module HS
       final: 'საბოლოო რედაქცია'
     }.freeze
 
-    def preview
-      body_element
-    end
-
     def review_icon
       REVIEW_ICON[review_status.to_sym]
     end
@@ -45,23 +37,5 @@ module HS
     def review_color
       REVIEW_COLOR[review_status.to_sym]
     end
-
-    private
-
-    def body_element
-      [
-        intro_preview,
-        content_preview
-      ].join("\n")
-    end
-
-    def intro_preview
-      return unless intro
-      intro.preview
-    end
-
-    def content_preview
-      content.map(&:preview).compact.join
-    end
   end
 end

data/lib/hs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HS
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/hs.rb

@@ -5,6 +5,7 @@ require 'hs/config'
 
 require 'hs/models/course'
 require 'hs/models/chapter'
+require 'hs/models/module'
 
 require 'hs/elements/element'
 require 'hs/elements/br'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hs-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Dimitri Kurashvili
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-26 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -218,6 +218,7 @@ files:
 - app/views/chapter.erb
 - app/views/course.erb
 - app/views/layout.erb
+- app/views/module.erb
 - bin/console
 - bin/setup
 - exe/hscli
@@ -248,13 +249,15 @@ files:
 - lib/hs/loaders/chapter_loader.rb
 - lib/hs/loaders/course_loader.rb
 - lib/hs/loaders/element_loader.rb
+- lib/hs/loaders/module_loader.rb
 - lib/hs/loaders/xml_parser.rb
 - lib/hs/models/chapter.rb
 - lib/hs/models/course.rb
-- lib/hs/preview/chapter_preview.rb
-- lib/hs/preview/course_preview.rb
+- lib/hs/models/module.rb
+- lib/hs/models/review_status.rb
+- lib/hs/preview/content_preview.rb
 - lib/hs/preview/element_preview.rb
-- lib/hs/preview/html_preview.rb
+- lib/hs/preview/review_status_preview.rb
 - lib/hs/version.rb
 homepage: http://github.com/hackersrc/hs-cli
 licenses:

data/lib/hs/preview/course_preview.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require 'hs/preview/html_preview'
-
-module HS
-  module CoursePreview
-    include HS::HTMLPreview
-
-    def preview
-      html_preview do
-        body_element
-      end
-    end
-
-    def save_preview
-      file = "#{HS::Config.preview_dir}/index.html"
-      File.open(file, 'w') { |f| f.write(preview) }
-    end
-
-    private
-
-    def body_element
-      [
-        '<body>',
-        title_preview,
-        toc_preview,
-        '</body>'
-      ].join("\n")
-    end
-
-    def title_preview
-      "  <h1 class=\"title\">#{title.strip}</h1>"
-    end
-
-    def toc_preview
-      [
-        '  <ul>',
-        chapters.map(&:toc_preview).join("\n"),
-        '  </ul>'
-      ].join("\n")
-    end
-  end
-end

data/lib/hs/preview/html_preview.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module HS
-  module HTMLPreview
-    def html_preview
-      body = yield
-      [
-        '<html>',
-        head_element,
-        body,
-        '</html>'
-      ].compact.join("\n")
-    end
-
-    private
-
-    def head_element
-      [
-        '<head>',
-        '<meta charset="utf-8"/> ',
-        '<meta name="viewport" content="width=device-width, initial-scale=1"/>',
-        '<link rel="stylesheet" href="/default.css"/>',
-        '</head>'
-      ].join("\n")
-    end
-  end
-end