hs-cli 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1f1911dbebb05033050a47fb13af39c36f91381f8787aac030660fe93425d4a
-  data.tar.gz: 64a451d68bd3b611090bb95c997e6f1e8eed4e6c322325cae71fe84805a2b468
+  metadata.gz: afc4b0f4d4ced43015bb231e2f1f5ac5f9718d894d05e5693f347b9a9a470265
+  data.tar.gz: 5dc88339bbec902c7cc61dc2dfc91bb9c517ddf86de34c060f1ae866be960739
 SHA512:
-  metadata.gz: 785b085c2b24c4f3a19da3fd39a5a9ff727698d057fb3394503471abb105b83c118fc04381327760813755e3d01586d598785bb753b456fe619e74dfa09ca463
-  data.tar.gz: 68c80f160635c6e63e2878e3b74cebe099d431aa538e1351afc132da41fa5b0cb5debe94bcf9d2d1c874455bc6ba98479740e77c3c6e13c01805213c081a8a6a
+  metadata.gz: 7deedf1c8db3b2e0493ac7ff951a58e8f272f8a1519e6c3ff4f37a0df373e20f496458a5fff62ce7c2d6860bcde5a0d5c1bb7aec03fbaff6b4bed26ca9c810ac
+  data.tar.gz: 1a8d255f8d7440554326e4d57859d4eae1409f21f700d5303aa23477c64548624808e28b3b9bf81ebd1a58542f65034c63d6252e0d5aa8e5198c886381fefe23

data/Gemfile.lock

@@ -1,9 +1,12 @@
 PATH
   remote: .
   specs:
-    hs-cli (0.1.2)
+    hs-cli (0.2.0)
       activesupport (~> 5.2)
-      nokogiri (> 1)
+      nokogiri (~> 1.8)
+      rack-contrib (~> 2.0)
+      sinatra (~> 2.0)
+      thor (~> 0.20)
 
 GEM
   remote: https://rubygems.org/
@@ -23,6 +26,7 @@ GEM
     method_source (0.9.0)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
+    mustermann (1.0.3)
     nokogiri (1.8.4)
       mini_portile2 (~> 2.3.0)
     parallel (1.12.1)
@@ -32,6 +36,11 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    rack (2.0.5)
+    rack-contrib (2.0.1)
+      rack (~> 2.0)
+    rack-protection (2.0.3)
+      rack
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
@@ -63,7 +72,14 @@ GEM
     rubocop-rspec (1.27.0)
       rubocop (>= 0.56.0)
     ruby-progressbar (1.10.0)
+    sinatra (2.0.3)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.3)
+      tilt (~> 2.0)
+    thor (0.20.0)
     thread_safe (0.3.6)
+    tilt (2.0.8)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     unicode-display_width (1.4.0)
@@ -74,13 +90,13 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   hs-cli!
-  pry (> 0.11)
+  pry (~> 0.11)
   rake (~> 10.0)
   rspec (~> 3.0)
   rspec-collection_matchers (~> 1.1)
   rspec-its (~> 1.2)
-  rubocop (> 0.58)
-  rubocop-rspec (> 1.20)
+  rubocop (~> 0.58)
+  rubocop-rspec (~> 1.20)
 
 BUNDLED WITH
    1.16.3

data/README.md

@@ -1,32 +1,82 @@
 [![Build Status](https://travis-ci.org/hackersrc/hs-cli.svg?branch=master)](https://travis-ci.org/hackersrc/hs-cli)
 
-# HS
+# hs-cli
 
-## ინსტალაცია
+## Installation
 
     $ gem install hs-cli
 
-## გამოყენება
+## Usage
+
+### Local server
+
+If your course XML path is at `content/course.xml` you
+can start local server using command:
+
+```sh
+hscli content/course.xml
+```
+
+You should be able to see your course on
+[localhost:8080](http://localhost:8080).
+
+### Course XML format
+
+Example of course XML file:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<course
+  slug="getting-started-with-the-web"
+>
+  <title>
+    ვებ დეველოპმენტი დამწყებთათვის
+  </title>
+
+  <chapters>
+    <chapter file="01-overview.xml" />
+    <chapter file="02-basic-software.xml" />
+    <chapter file="03-what-will-your-website-look-like.xml" />
+    <chapter file="04-dealing-with-files.xml" />
+    <chapter file="05-html-basics.xml" />
+    <chapter file="06-css-basics.xml" />
+    <chapter file="07-js-basics.xml" />
+    <chapter file="08-publishing-your-website.xml" />
+    <chapter file="09-how-the-web-works.xml" />
+  </chapters>
+</course>
+```
+
+### Chapter XML format
+
+Example of chapter XML file:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter slug="overview">
+  <title>
+    კურსის მიმოხილვა
+  </title>
+
+  <intro>
+    "ვებ დეველოპმენტი დამწყებთათვის" არის პრაქტიკული ვებ პროგრამირების მოკლე კურსი.
+    თქვენ შეისწავლით როგორ შექმნათ და გამოაქვეყნოთ მარტივი ვებგვერდის კოდი.
+  </intro>
+
+  <p>
+    პროფესიონალური ვებსაიტის შექმნა ბევრ შრომას მოითხოვს.
+    თუ დამწყები ხართ სჯობს არ აჩქარდეთ, რადგან დღესვე შემდეგი
+    ფეისბუკის შექმნა გაგიჭირდებათ.
+    მაგრამ თქვენი მარტივი ვებგვერდის ინტერნეტში გაშვება არაა რთული.
+  </p>
+</chapter>
+```
+
+### More examples
+
+You can find out more looking at our
+[example course repo](https://github.com/hackersrc/getting-started-with-the-web).
 
-### კონფიგურაცია
-
-ფაილი `.hs` გამოიყენება კონფიგურაციის ჩასაწერად.
-
-კონფიგურაციაში ჩაწერეთ თქვენი მომხარებელი და პაროლი,
-რომლითაც ხართ რეგისტრირებული [ჰაკერების სკოლაში](http://hackerschool.ge).
-
-    USERNAME=dimitri
-    PASSWORD=secret
-
-### ბრაძანებები
-
-სტატიკური კურსის გენერაცია შეგიძლიათ ბრძანებით:
-
-    $ hs --out=html
-
-კურსის ატვირთვა [ჰაკერების სკოლაში](http://hackerschool.ge):
-
-    $ hs --sync
 
 ## Development
 

data/app/public/default.css

@@ -0,0 +1,21 @@
+.note {
+  margin: 2em 0;
+  background-color: #ffc;
+  padding: 32px;
+  max-width: 960px;
+}
+
+.note.important {
+  background-color: #fcc;
+}
+
+pre {
+  border-left: 3px solid rgba(0, 0, 255, 0.75) !important;
+  padding: 1em;
+  background-color: rgba(190, 200, 255, 0.25);
+}
+
+.wrong-code {
+  border-left: 3px solid rgba(255, 0, 0, 0.75) !important;
+  background-color: rgba(255, 0, 0, 0.05);
+}

data/app/views/_footer.erb

@@ -0,0 +1,6 @@
+<div class="uk-container">
+  <p>
+    &copy; 2018
+    <a href="http://hakcerschool.ge">ჰაკერების სკოლა</a>
+  </p>
+</div>

data/app/views/_nav.erb

@@ -0,0 +1,14 @@
+<hr />
+
+<div class="uk-container">
+  <ul class="uk-breadcrumb">
+    <li>
+      <a href="/"><%= course %></a>
+    </li>
+    <li>
+      <span><%= chapter %></span>
+    </li>
+  </ul>
+</div>
+
+<hr />

data/app/views/chapter.erb

@@ -0,0 +1,20 @@
+<div class="uk-section">
+  <div class="uk-container">
+    <h1>
+      <%= @chapter.title %>
+    </h1>
+  </div>
+
+
+
+  <%= erb :_nav, layout: false, locals: { course: @course.title, chapter: @chapter.title } %>
+
+  
+
+  <div class="uk-container">
+    <%= @chapter.preview %>
+  </div>
+
+  <%= erb :_nav, layout: false, locals: { course: @course.title, chapter: @chapter.title } %>
+  <%= erb :_footer, layout: false %>
+</div>

data/app/views/course.erb

@@ -0,0 +1,28 @@
+<div class="uk-section">
+  <div class="uk-container">
+    <h1 class="uk-heading">
+      <%= @course.title %>
+    </h1>
+  </div>
+
+  <hr />
+
+  <div class="uk-container">
+    <h2 class="toc-title">
+      კურსის შინაარსი
+    </h2>
+
+    <ol class="toc">
+      <% @course.chapters.each do |chapter| %>
+        <li>
+          <a href="/<%= chapter.slug %>">
+            <%= chapter.title %>
+          </a>
+        </li>
+      <% end %>
+    </ol>
+  </div>
+
+  <hr />
+  <%= erb :_footer, layout: false %>
+</div>

data/app/views/layout.erb

@@ -0,0 +1,15 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <title><%= @title %></title>
+  <link rel="stylesheet" href="/default.css" />
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/uikit/3.0.0-rc.10/css/uikit.min.css" />
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/uikit/3.0.0-rc.10/js/uikit.min.js"></script>
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/uikit/3.0.0-rc.10/js/uikit-icons.min.js"></script>
+</head>
+<body>
+  <%= yield %>
+</body>
+</html>

data/exe/hscli

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'thor'
+require 'hs'
+
+class Hscli < Thor
+  desc 'start ENTRY', 'starts local development server for ENTRY'
+  method_option :bind, aliases: '-b', desc: 'Bind address', default: '0.0.0.0'
+  method_option :port, aliases: '-p', desc: 'Port ', default: '8080'
+  def start(entry)
+    HS::DevServer.create(
+      bind: options[:bind],
+      port: options[:port],
+      entry: entry
+    ).run!
+  end
+end
+
+Hscli.start

data/hs.gemspec

@@ -28,14 +28,17 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '~> 5.2'
-  spec.add_dependency 'nokogiri', '> 1'
+  spec.add_dependency 'nokogiri', '~> 1.8'
+  spec.add_dependency 'rack-contrib', '~> 2.0'
+  spec.add_dependency 'sinatra', '~> 2.0'
+  spec.add_dependency 'thor', '~> 0.20'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'pry', '> 0.11'
+  spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-collection_matchers', '~> 1.1'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
-  spec.add_development_dependency 'rubocop', '> 0.58'
-  spec.add_development_dependency 'rubocop-rspec', '> 1.20'
+  spec.add_development_dependency 'rubocop', '~> 0.58'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.20'
 end

data/lib/hs/devserver.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'sinatra/base'
+require 'rack/contrib/try_static'
+
+module HS
+  class DevServer
+    class << self
+      attr_accessor :app, :entry
+
+      def create(config = {})
+        self.entry = config[:entry] || 'content/course.xml'
+        self.app = initialize_application(config)
+        set_root_route
+        set_chapter_route
+        app
+      end
+
+      private
+
+      def initialize_application(config)
+        public_folder = config[:public_folder] || 'public'
+        hs_public_folder = File.expand_path('../../app/public', __dir__)
+        Sinatra.new do
+          set(:bind, '0.0.0.0')
+          set(:port, 8080)
+          set(:views, File.expand_path('../../app/views', __dir__))
+          set(:public_folder, public_folder)
+          use(Rack::TryStatic, root: hs_public_folder, urls: %w[/])
+        end
+      end
+
+      def set_root_route
+        entry = self.entry
+
+        app.get '/' do
+          @course = HS::Course.load(entry)
+          @title = @course.title
+
+          erb :course
+        end
+      end
+
+      def set_chapter_route
+        entry = self.entry
+
+        app.get '/:slug' do
+          @course = HS::Course.load(entry)
+          @chapter = @course.find_chapter(params[:slug])
+          @title = @chapter.title
+
+          erb :chapter
+        end
+      end
+    end
+  end
+end

data/lib/hs/elements/intro.rb

@@ -3,7 +3,7 @@
 module HS
   class Intro < HS::Element
     def default_class
-      'intro'
+      'uk-text-lead'
     end
   end
 end

data/lib/hs/{course.rb → models/course.rb}

@@ -28,6 +28,10 @@ module HS
       @chapters = []
     end
 
+    def find_chapter(slug)
+      chapters.find { |c| c.slug == slug }
+    end
+
     def hs_url
       "#{HS::Config.publish_url}/learn/#{slug}"
     end

data/lib/hs/preview/chapter_preview.rb

@@ -7,30 +7,16 @@ module HS
     include HS::HTMLPreview
 
     def preview
-      html_preview do
-        body_element
-      end
-    end
-
-    def toc_preview
-      "<li><a href=\"/#{slug}\">#{title.strip}</a></li>"
-    end
-
-    def save_preview
-      file = "#{HS::Config.preview_dir}/#{slug}.html"
-      File.open(file, 'w') { |f| f.write(preview) }
+      body_element
     end
 
     private
 
     def body_element
       [
-        '<body>',
-        title_preview,
         intro_preview,
-        content_preview,
-        '</body>'
-      ]
+        content_preview
+      ].join("\n")
     end
 
     def intro_preview
@@ -38,10 +24,6 @@ module HS
       intro.preview
     end
 
-    def title_preview
-      "<h1 class=\"title\">#{title.strip}</h1>"
-    end
-
     def content_preview
       content.map(&:preview).compact.join
     end

data/lib/hs/version.rb

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

data/lib/hs.rb

@@ -3,8 +3,8 @@
 require 'hs/version'
 require 'hs/config'
 
-require 'hs/course'
-require 'hs/chapter'
+require 'hs/models/course'
+require 'hs/models/chapter'
 
 require 'hs/elements/element'
 require 'hs/elements/br'
@@ -26,3 +26,5 @@ require 'hs/elements/strong'
 require 'hs/elements/table'
 require 'hs/elements/text'
 require 'hs/elements/ul'
+
+require 'hs/devserver'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hs-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Dimitri Kurashvili
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,16 +28,58 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rack-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -56,14 +98,14 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
 - !ruby/object:Gem::Dependency
@@ -126,34 +168,35 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.58'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.58'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.20'
 description: Client for working on HackerSchool projects
 email:
 - dimitri@hackerschool.ge
-executables: []
+executables:
+- hscli
 extensions: []
 extra_rdoc_files: []
 files:
@@ -168,13 +211,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/public/default.css
+- app/views/_footer.erb
+- app/views/_nav.erb
+- app/views/chapter.erb
+- app/views/course.erb
+- app/views/layout.erb
 - bin/console
 - bin/setup
+- exe/hscli
 - hs.gemspec
 - lib/hs.rb
-- lib/hs/chapter.rb
 - lib/hs/config.rb
-- lib/hs/course.rb
+- lib/hs/devserver.rb
 - lib/hs/elements/br.rb
 - lib/hs/elements/code.rb
 - lib/hs/elements/dd.rb
@@ -199,6 +248,8 @@ files:
 - lib/hs/loaders/course_loader.rb
 - lib/hs/loaders/element_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/preview/element_preview.rb