daigaku 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8b67152f8cdc2685c5b2edfa2cf611f1f81eb61
+  data.tar.gz: e969647bd2749977c6f6a4967afbf826b46c291e
+SHA512:
+  metadata.gz: 431903dc0fb3e12805b76b94950d47a794180617dd21b25c6dc7c486734f750fadb27cfc4059d6f6a507a72a7995f15e5b2e0e0f356f266f25955624d05986a2
+  data.tar.gz: fb34667ddd6b7c30af0a22aa86d1bc5a2b6090fc2f0e22d9726fd5b2beb8b1b77592edb5e1241204a4d3a80f955d5050876f4f8633bed70864e3bfdd8d74cc9d

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/.idea
+.project

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in daigaku.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec',  cmd: 'rspec', all_after_pass: true do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -0,0 +1,62 @@
+# ![Daigaku](http://res.cloudinary.com/daigaku-ruby/image/upload/c_scale,h_100/v1426946323/rect5481_si3rjr.png)
+
+Daigaku (大学) is the Japanese word for **university**.
+
+With Daigaku you can master your way of learning the Ruby programming
+language with courses that are created by the community.
+
+Daigaku is a command line tool and a text based interface and provides
+you with a number of learning tasks and explanations about the Ruby
+programming language. You will learn Ruby step by step by solving small
+language-explaining programming tasks.
+
+## Installation
+
+First of all make sure Ruby is installed on your computer.
+
+Then open a terminal and install Daigaku by running:
+
+    $ gem install daigaku
+
+## Get started
+
+To get started open a terminal and run following line:
+
+    $ daigaku welcome
+
+Daigaku will lead you through the setup and some important commands.
+
+## Command line interface
+
+Daigaku's command line interface provides several commands which you
+can use in your terminal to setup the system, download new courses,
+and navigate through your solutions.
+
+Please visit the [Daigaku Wiki](https://github.com/daigaku-ruby/daigaku/wiki/How-to-use-Daigaku%27s-command-line-interface-%28CLI%29) to learn more about available commands.
+
+## Daigaku screen
+
+Daigaku's text based interface - the Daigaku screen - shows your installed courses and allows you to navigate through their chapters and units. In the task view you can read the unit's task and validate your solution code.
+
+Please visit the [Diagaku Wiki](https://github.com/daigaku-ruby/daigaku/wiki/How-to-learn-Ruby-in-the-Daigaku-screen) to learn how to use the Daigaku screen.
+
+## Contributing
+
+We encourage you to contribute to Daigaku development and course creation.
+
+### Creating Daigaku courses
+
+You can create your own Daigaku courses and make them available to the community.
+Learn how to create a Daigaku course in the [Daigaku Wiki](https://github.com/daigaku-ruby/daigaku/wiki/How-to-create-a-Daigaku-course).
+
+### Development
+
+1. Fork it ( https://github.com/daigaku-ruby/daigaku/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+### License
+
+Daigaku is released under the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/daigaku

@@ -0,0 +1,12 @@
+#! /usr/bin/env ruby
+
+require 'rubygems'
+
+begin
+  require 'daigaku'
+rescue LoadError => e
+  warn "could not load \"daigaku\"\n#{e}"
+  exit -1
+end
+
+Daigaku::Terminal::CLI.start

data/daigaku.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'daigaku/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "daigaku"
+  spec.version       = Daigaku::VERSION
+  spec.authors       = ["Paul Götze"]
+  spec.email         = ["paul.christoph.goetze@gmail.com"]
+  spec.summary       = %q{Learning Ruby on the command line.}
+  spec.description   = %q{Daigaku is the Japanese word for university. With Daigaku you can interactively learn the Ruby Programming language using the command line.}
+  spec.homepage      = "https://github.com/daigaku-ruby/daigaku"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  if RUBY_VERSION >= '2.1'
+    spec.add_runtime_dependency "curses", ">= 1.0", "< 2.0"
+  end
+
+  spec.add_runtime_dependency "activesupport", ">= 4.0", "< 5.0"
+  spec.add_runtime_dependency "rspec", ">= 3.0", "< 4.0"
+  spec.add_runtime_dependency "thor", "~> 0.19.1"
+  spec.add_runtime_dependency "os", "~> 0.9.6"
+  spec.add_runtime_dependency "colorize", "~> 0.7.5"
+  spec.add_runtime_dependency "rubyzip", ">= 1.0", "< 2.0"
+  spec.add_runtime_dependency "wisper", ">= 2.0.0.rc1", "< 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "webmock", "~> 1.20.4"
+  spec.add_development_dependency "guard-rspec", "~> 4.5.0"
+end

data/lib/daigaku.rb

@@ -0,0 +1,27 @@
+require 'daigaku/window'
+
+Dir[File.join("#{File.dirname(__FILE__)}/**/*.rb")].sort.each do |file|
+  require file
+end
+
+module Daigaku
+
+  class << self
+    def config
+      Configuration.instance
+    end
+
+    def configure
+      yield(config) if block_given?
+    end
+
+    def start
+      Views::Splash.new
+      Views::MainMenu.new
+    end
+
+    def database
+      Database.instance
+    end
+  end
+end

data/lib/daigaku/chapter.rb

@@ -0,0 +1,23 @@
+module Daigaku
+  class Chapter
+
+    attr_reader :title, :path
+
+    def initialize(path)
+      @path = path
+      @title = File.basename(path).gsub(/\_+/, ' ')
+    end
+
+    def units
+      @units ||= Loading::Units.load(@path)
+    end
+
+    def started?
+      units.reduce(false) { |started, unit| started ||= unit.mastered? }
+    end
+
+    def mastered?
+      units.reduce(true) { |mastered, unit| mastered &&= unit.mastered? }
+    end
+  end
+end

data/lib/daigaku/configuration.rb

@@ -0,0 +1,86 @@
+module Daigaku
+  require 'singleton'
+  require 'yaml'
+  require 'fileutils'
+
+  class Configuration
+    include Singleton
+
+    LOCAL_DIR = '.daigaku'
+    COURSES_DIR = 'courses'
+    SOLUTIONS_DIR = 'solutions'
+    STORAGE_FILE = 'daigaku.db.yml'
+    DAIGAKU_INITIAL_COURSE = 'daigaku-ruby/Get_started_with_Ruby'
+
+    attr_accessor :courses_path
+    attr_reader :storage_file
+
+    def initialize
+      @courses_path = local_path_to(COURSES_DIR)
+      @storage_file = local_path_to(STORAGE_FILE)
+
+      yield if block_given?
+    end
+
+    def solutions_path
+      @solutions_path || raise(Daigaku::ConfigurationError, 'Solutions path is not set.')
+    end
+
+    def solutions_path=(path)
+      full_path = File.expand_path(path, Dir.pwd)
+
+      unless Dir.exist?(full_path)
+        error = [
+          Daigaku::ConfigurationError,
+          "Solutions path \"#{path}\" isn't an existing directory."
+        ]
+
+        raise(*error)
+      end
+
+      @solutions_path = full_path
+    end
+
+    def save
+      settings = self.instance_variables
+      settings.delete(:@storage_file)
+
+      settings.each do |variable|
+        key = variable.to_s.delete('@')
+        value = self.instance_variable_get(variable.to_sym)
+        Database.set(key, value)
+      end
+    end
+
+    def import!
+      @courses_path = Database.courses_path || @courses_path
+      @solutions_path = Database.solutions_path || @solutions_path
+      self
+    end
+
+    def summary
+      settings = self.instance_variables
+      settings.delete(:@storage_file)
+
+      lines = settings.map do |variable|
+        key = variable.to_s.delete('@').gsub('_', ' ')
+        value = self.instance_variable_get(variable.to_sym)
+        "* #{key}: #{value}"
+      end
+
+      lines.join("\n")
+    end
+
+    def initial_course
+      DAIGAKU_INITIAL_COURSE
+    end
+
+    private
+
+    def local_path_to(*resource)
+      path = File.join('~', LOCAL_DIR, resource)
+      File.expand_path(path, __FILE__)
+    end
+  end
+
+end

data/lib/daigaku/course.rb

@@ -0,0 +1,23 @@
+module Daigaku
+  class Course
+
+    attr_reader :title, :path, :author, :link
+
+    def initialize(path)
+      @path = path
+      @title = File.basename(path).gsub(/\_+/, ' ')
+    end
+
+    def chapters
+      @chapters ||= Loading::Chapters.load(@path)
+    end
+
+    def started?
+      chapters.reduce(false) { |started, chapter| started ||= chapter.started? }
+    end
+
+    def mastered?
+      chapters.reduce(true) { |mastered, chapter| mastered &&= chapter.mastered? }
+    end
+  end
+end

data/lib/daigaku/database.rb

@@ -0,0 +1,64 @@
+require 'yaml/store'
+require 'fileutils'
+
+module Daigaku
+
+  class Database
+    include Singleton
+
+    attr_reader :file
+
+    def initialize
+      @file = Daigaku.config.storage_file
+      directory = File.dirname(@file)
+      FileUtils.makedirs(directory) unless Dir.exist?(directory)
+
+      @db = YAML::Store.new(@file)
+    end
+
+    def set(key, value)
+      @db.transaction { @db[key.to_s] = value }
+    end
+
+    def get(key)
+      @db.transaction { @db[key.to_s] }
+    end
+
+    def self.get(key)
+      instance.get(key)
+    end
+
+    def self.set(key, value)
+      instance.set(key, value)
+    end
+
+    def self.file
+      instance.file
+    end
+
+    # Defines getter and setter methods for arbitrarily named methods.
+    # @xample
+    #   Diagaku::Database.answer = 42
+    #   => saves 'answer: 42' to database
+    #
+    #   Daigaku::Database.answer
+    #   => 42
+    def self.method_missing(method, *args, &block)
+      if method =~ /.*=$/
+        if singleton_methods.include?(method.to_s.chop.to_sym)
+          raise "There is a \"#{method.to_s.chop}\" instance method already " +
+            "defined. This will lead to problems while getting values " +
+            "from the database. Please use another key than " +
+            "#{singleton_methods.map(&:to_s)}."
+        end
+
+        instance.set(method.to_s.gsub(/=$/, ''), args[0])
+      elsif args.count == 0
+        instance.get(method)
+      else
+        super
+      end
+    end
+  end
+
+end

data/lib/daigaku/exceptions.rb

@@ -0,0 +1,19 @@
+module Daigaku
+
+  class Error < StandardError; end
+  class CourseNotFoundError < Error; end
+  class ChaptersNotFoundError < Error; end
+  class UnitsNotFoundError < Error; end
+  class TaskNotFoundError < Error; end
+  class ReferenceSolutionNotFoundError; end
+  class SolutionNotFoundError < Error; end
+  class ScaffoldError < Error; end
+
+  class ConfigurationError < Error; end
+
+  module Download
+    class NoUrlError < Error; end
+    class NoZipFileUrlError < Error; end
+  end
+
+end

data/lib/daigaku/generator.rb

@@ -0,0 +1,53 @@
+module Daigaku
+  require 'fileutils'
+  require 'active_support'
+  require 'active_support/core_ext'
+
+  class Generator
+
+    SOLUTION_SUFFIX = '_solution.rb'
+
+    def scaffold(courses_path, target_path)
+      Dir[File.join(courses_path, "**/*.md")].each do |file|
+        content_dir = File.join(*file.split('/')[-4..-2])
+        directory = File.join(target_path, File.dirname(content_dir))
+
+        unit_name = File.basename(content_dir)
+        solution_file = unit_name.gsub(/(\_+|\-+|\.+)/, '_') + SOLUTION_SUFFIX
+        file_path = File.join(directory, solution_file)
+
+        create_dir(directory)
+        create_file(file_path)
+      end
+    end
+
+    def prepare
+      begin
+        solutions_path = Daigaku.config.solutions_path
+      rescue ConfigurationError => e
+        base_dir = File.dirname(Daigaku.config.courses_path)
+        solutions_dir = Daigaku::Configuration::SOLUTIONS_DIR
+        solutions_path = File.join(base_dir, solutions_dir)
+      end
+
+      create_dir(Daigaku.config.courses_path)
+      create_dir(solutions_path)
+
+      Daigaku.config.solutions_path = solutions_path
+      Daigaku.config.save
+    end
+
+    private
+
+    def create_dir(path)
+      return if path.blank?
+      FileUtils.makedirs(path) unless Dir.exist?(path)
+    end
+
+    def create_file(path)
+      return if path.blank?
+      create_dir(File.dirname(path))
+      FileUtils.touch(path) unless File.exist?(path)
+    end
+  end
+end