question_compiler 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ba34bc5b728df960376e88dca9625b8f9b600e6
+  data.tar.gz: b40716c4e48cef949c7b6c60af5c1963246917c6
+SHA512:
+  metadata.gz: 8d538f7526618e9820f0b9286e71aa71251ef6447d1b95bcbec6db7d5c40c65993ac833b1531cb6a44e3e59d837883159fa82e194dd66b304f95652fc45fcf34
+  data.tar.gz: 77b116b976c4ce7c026d984977565dfaf22435d9f12ccee73365503010a2f5ffe0020846b9d524495ea56e11f489acbddfb59fcf59727f184dee0cd24b1a217f

data/bin/qc

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+# When developing, run this script like so:
+#   DEV=1 ~/gems/question_compiler/bin/qc
+
+if ENV['DEV'] == '1'
+  puts "\n"
+  puts '======================================'
+  puts 'Question compiler running in dev mode.'
+  puts '======================================'
+  puts "\n"
+  
+  $:.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+  
+  dev = true
+else
+  dev = false
+end
+
+require 'question_compiler'
+require 'question_compiler/command'
+
+QuestionCompiler::Command.new(ARGV.dup, dev).run

data/lib/question_compiler.rb

@@ -0,0 +1,5 @@
+require 'nokogiri'
+
+require 'question_compiler/version'
+require 'question_compiler/compiler'
+require 'question_compiler/server'

data/lib/question_compiler/command.rb

@@ -0,0 +1,52 @@
+require 'fileutils'
+require 'logger'
+require 'slop'
+require 'zip'
+require 'question_compiler/local'
+require 'question_compiler/zipper'
+
+module QuestionCompiler
+  class Command
+    def initialize(args, dev = false)
+      @args = args
+      @dev = dev
+    end
+    
+    def run
+      opts = Slop.parse(@args) do |o|
+        o.bool '-z', '--zip', 'Builds zip files for all questions and contexts. Invoke from root folder.'
+        o.array '-c', '--compile', 'Builds the given questions Invoke from root folder. Usage: qc -c user1/qst1 user1/qst2 user2/qst3'
+        o.bool '-s', '--server', 'Starts a development webserver. Invoke from context or question folder.'
+        o.integer '-p', '--port', 'Webserver port.', default: 3000
+        o.on '-v', '--version', 'Prints the gem version.'
+        o.bool '-h', '--help', 'Prints this message.'
+      end
+      
+      if opts.help?
+        puts opts
+      elsif opts.version?
+        puts QuestionCompiler::VERSION
+      elsif opts.compile?
+        log = Logger.new(STDOUT)
+        log.level = Logger::DEBUG if @dev
+        opts[:compile].each do |question_path|
+          username, _ = question_path.split('/')
+          FileUtils.mkdir_p File.join('compiled', question_path)
+          FileUtils.cp_r File.join('questions', question_path), File.join('compiled', username)
+          
+          QuestionCompiler::Compiler.new(log).compile(
+            File.read(File.join('questions', question_path, 'question.html')),
+            QuestionCompiler::LocalContextReader.new('contexts'),
+            QuestionCompiler::LocalQuestionWriter.new('compiled', question_path)
+          )
+        end
+      elsif opts.zip?
+        QuestionCompiler::Zipper.new.zip_all Dir.getwd
+      elsif opts.server?
+        QuestionCompiler::Server.start opts[:port]
+      else
+        puts opts
+      end
+    end
+  end
+end

data/lib/question_compiler/compiler.rb

@@ -0,0 +1,86 @@
+module QuestionCompiler
+  class Compiler
+    attr_reader :context_path
+    
+    def copy_dependencies(context_reader, question_writer, directory)
+      @log.debug "Copying dependencies in #{directory}"
+      context_reader.glob(
+        File.join(directory, '/**/*')
+      ).reject do |dep_path|
+        !context_reader.file?(dep_path) or
+        File.basename(dep_path).start_with?('.')
+      end.each do |dep_path|
+        dep_path = dep_path.to_s
+        if dep_src = context_reader.read(dep_path)
+          question_writer.write dep_path, dep_src
+        end
+      end
+    end
+  
+    def copy_nodes(nodes_to_copy, dst_node, before)
+      @log.debug "Copying nodes [#{nodes_to_copy.map(&:name).join(', ')}] to #{dst_node.name}"
+      before = dst_node.at_css(before)
+      nodes_to_copy.each do |node|
+        if before
+          before.add_previous_sibling node
+        else
+          dst_node << node
+        end
+      end
+    end
+    
+    # Note that `QuestionCompiler::Server` doesn't call this. Instead, it calls
+    # `#transform_question` directly.
+    def compile(question_src, context_reader, question_writer)
+      context_reader.log = @log
+      question_writer.log = @log
+      question_writer.open do
+        question_doc = Nokogiri.HTML question_src
+        question_doc = transform_question(question_doc, context_reader) do |context_path|
+          copy_dependencies context_reader, question_writer, 'assets'
+        end
+      
+        question_writer.write 'question.html', question_doc.to_html
+      end
+    end
+    
+    def initialize(log)
+      @log = log
+    end
+    
+    # `QuestionCompiler::Server` calls this directly, bypassing `#compile`.
+    def transform_question(question_doc, context_reader)
+      context_reader.log = @log
+      question_head = question_doc.at_css('head')
+      @log.debug 'Looking for an embedded context'
+      if embed_div = question_doc.css('div[data-embed-context]').first
+        @context_path = embed_div['data-embed-context']
+        @log.debug "Found embedded context: #{@context_path}"
+        
+        context_reader.open(@context_path) do
+          if context_src = context_reader.read('context.html')
+            context_doc = Nokogiri.HTML context_src
+          
+            if question_head
+              copy_nodes context_doc.css('head link'),   question_head, 'link'
+              copy_nodes context_doc.css('head style'),  question_head, 'style'
+              copy_nodes context_doc.css('head script'), question_head, 'script'
+            end
+          
+            if context_body = context_doc.at_css('body')
+              embed_div.inner_html = ''
+              embed_div << context_body.inner_html
+            end
+        
+            if block_given?
+              yield @context_path
+            end
+          else
+            @log.warn "Could not read context.html in #{@context_path}"
+          end
+        end
+      end
+      question_doc
+    end
+  end
+end

data/lib/question_compiler/local.rb

@@ -0,0 +1,89 @@
+require 'fileutils'
+
+module QuestionCompiler  
+  class LocalContextReader
+    # Given a context path such as `jarrett/example` and a glob such as `assets/*.css`,
+    # returns an array of matching paths. The returned paths are relative to the
+    # context folder.
+    def glob(glob_str)
+      Dir.glob(File.join(@root, @context_path, glob_str)).select do |sub_path|
+        File.file? sub_path
+      end.map do |sub_path|
+        sub_path.sub(File.join('contexts', @context_path), '')
+      end
+    end
+    
+    def file?(sub_path)
+      File.file? File.join(@root, @context_path, sub_path)
+    end
+    
+    # Pass the path to the contexts folder. I.e. the folder whose children are usernames.
+    def initialize(root)
+      @root = root
+    end
+    
+    attr_accessor :log
+    
+    # Pass a path such as `jarrett/example`.
+    def open(context_path)
+      @context_path = context_path
+      # This is basically a no-op. Some other context reader implementations may need to
+      # open and close the question as a whole.
+      yield
+    end
+    
+    # Given a path to a file within the context such as `assets/context.css`, returns the
+    # file data as a string. Returns nil if the file doesn't exist or is unreadable.
+    def read(sub_path)
+      path = File.expand_path(File.join(@root, @context_path, sub_path))
+      begin
+        data = File.read path
+        @log.debug "R: #{path} (#{data.length} bytes)"
+        data
+      rescue Exception
+        @log.warn "Could not read #{path}"
+        nil
+      end
+    end
+  end
+
+  class LocalQuestionWriter
+    # Pass the path to the compiled folder. I.e. the folder whose children are question names.
+    def initialize(root, question_path)
+      @root = root
+      @question_path = question_path
+    end
+    
+    attr_accessor :log
+    
+    def open
+      # This is basically a no-op. Some other question writer implementations may need to
+      # open and close the question as a whole.
+      yield
+    end
+    
+    # Given a path within the question such as `assets/style.css` and the data, writes
+    # the file. Returns true if the file was written successfully. Returns false is the
+    # file was unwritable.
+    def write(sub_path, data)
+      path = File.expand_path(File.join(@root, @question_path, sub_path))
+      @log.debug "W: #{path} (#{data.length} bytes)"
+      begin
+        FileUtils.mkdir_p File.dirname(path)
+        File.open(path, 'w') do |f|
+          f << data
+        end
+        true
+      rescue Exception
+        fail_write path
+      end
+    end
+    
+    private
+    
+    def fail_write(path)
+      @log.warn "Could not write #{path}"
+      false
+    end
+  end
+end

data/lib/question_compiler/server.rb

@@ -0,0 +1,81 @@
+module QuestionCompiler
+  module Server
+    def self.start(port)
+      require 'rack'
+      app = QuestionHandler.new Dir.getwd
+      begin
+        Rack::Handler::WEBrick.run app, Port: port
+      ensure
+        app.cleanup
+      end
+    end
+    
+    class QuestionHandler
+      def call(env)
+        req = Rack::Request.new env
+        
+        if req.path == '/question.html'
+          serve_question
+        else
+          maybe_serve_context_file env, req
+        end
+      end
+      
+      def cleanup
+        path = File.join @root, '.context-path'
+        if File.exists? path
+          File.delete path
+        end
+      end
+      
+      def initialize(root)
+        @root = root
+        @context_reader = LocalContextReader.new File.join(@root, '../../../contexts')
+      end
+      
+      def read_context_path
+        path = File.join @root, '.context-path'
+        if File.exists? path
+          File.read path
+        else
+          nil
+        end
+      end
+      
+      def maybe_serve_context_file(env, req)
+        if context_path = read_context_path
+          context_root = File.expand_path(
+            File.join(@root, '../../../contexts', context_path)
+          )
+          file_path = File.join(context_root, req.path)
+          if File.exists? file_path
+            Rack::File.new(context_root).call env
+          else
+            Rack::File.new(@root).call env
+          end
+        else
+          serve_generic env
+        end
+      end
+      
+      def serve_generic(env)
+        Rack::File.new(@root).call env
+      end
+      
+      def serve_question
+        compiler = QuestionCompiler::Compiler.new(Logger.new(STDOUT))
+        question_src = File.read 'question.html'
+        question_doc = Nokogiri.HTML question_src
+        question_doc = compiler.transform_question question_doc, @context_reader
+        write_context_path compiler.context_path
+        [200, {'Content-Type' => 'text/html'}, [question_doc.to_html]]
+      end
+      
+      def write_context_path(context_path)
+        File.open('.context-path', 'w') do |f|
+          f << context_path
+        end
+      end
+    end
+  end
+end

data/lib/question_compiler/version.rb

@@ -0,0 +1,3 @@
+module QuestionCompiler
+  VERSION = '0.0.0'
+end

data/lib/question_compiler/zipper.rb

@@ -0,0 +1,97 @@
+require 'fileutils'
+
+module QuestionCompiler
+  class Zipper
+    # Zips each question and each context, placing the results into the `zip` subfolder.
+    # Creates `zip` if it doesn't exist.
+    # 
+    # Pass the path to the root folder. I.e. the folder that contains the subfolders
+    # `questions` and `contexts`.
+    def zip_all(dir)
+      FileUtils.mkdir_p File.join(dir, 'zip')
+      
+      # Zip each question.
+      Dir.glob(File.join(dir, 'questions/*/*')).each do |question_path|
+        if File.directory? question_path
+          question_name = File.basename(question_path).sub('/', '-')
+          zip_folder(
+            question_path,
+            File.join(dir, 'zip', question_name + '.qst.zip')
+          )
+        end
+      end
+      
+      # Zip each context.
+      Dir.glob(File.join(dir, 'contexts/*/*')).each do |context_path|
+        if File.directory? context_path
+          context_name = File.basename(context_path).sub('/', '-')
+          zip_folder(
+            context_path,
+            File.join(dir, 'zip', context_name + '.ctx.zip')
+          )
+        end
+      end
+    end
+    
+    private
+    
+    # Zips up `src_path` and writes the zip file to `dst_path`.
+    def zip_folder(src_path, dst_path)
+      FileUtils.rm_f dst_path
+      Zip::File.open(dst_path, Zip::File::CREATE) do |zip|
+        # Nest everything inside one folder.
+        zip_path_prefix = File.basename(src_path)
+        zip.mkdir zip_path_prefix
+        zip_folder_recursively(
+          zip_path_prefix,            # Zip path prefix.
+          File.expand_path(src_path), # Disk path prefix.
+          '',                         # Folder disk path.
+          zip
+        )
+      end
+    end
+    
+    # Helper method for `#zip_folder`.
+    # 
+    # In this method, we document each path variable with reference to the following
+    # example filesystem layout, where root is the folder being zipped:
+    # root
+    #   apples.txt
+    #   dir-1
+    #     dir-2
+    #       bananas.txt
+    def zip_folder_recursively(
+      zip_path_prefix,  # E.g. 'root'
+      disk_path_prefix, # E.g. '/home/username/documents/root'
+      folder_path,      # E.g. 'dir-1/dir-2'
+      zip
+    )  
+      # E.g. ['apples.txt', 'subfolder']
+      entries = Dir.entries(File.join(disk_path_prefix, folder_path)) - ['.', '..']
+      
+      entries.each do |entry|
+        # E.g. '/home/username/documents/root/dir-1/dir-2/bananas.txt'
+        abs_disk_path = File.join disk_path_prefix, folder_path, entry
+        
+        if File.directory? abs_disk_path
+          # E.g. 'root/dir-1/dir-2'
+          zip.mkdir File.join(zip_path_prefix, folder_path, entry) 
+          
+          zip_folder_recursively(
+            zip_path_prefix,               # E.g. 'root'
+            disk_path_prefix,              # E.g. '/home/username/documents/root'
+            File.join(folder_path, entry), # E.g. 'dir-1/dir-2'
+            zip
+          )
+        else
+          zip.add(
+            # E.g. 'root/dir-1/dir-2/bananas.txt'
+            File.join(zip_path_prefix, folder_path, entry),
+            # E.g. '/home/username/documents/root/dir-1/dir-2/bananas.txt'
+            File.join(disk_path_prefix, folder_path, entry)
+          )
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: question_compiler
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Jarrett Colby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: 
+email: jarrett@uchicago.edu
+executables:
+- qc
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/qc
+- lib/question_compiler.rb
+- lib/question_compiler/command.rb
+- lib/question_compiler/compiler.rb
+- lib/question_compiler/local.rb
+- lib/question_compiler/server.rb
+- lib/question_compiler/version.rb
+- lib/question_compiler/zipper.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Compiler for Number Stories questions
+test_files: []