daigaku 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ce9d43dc806807d9613ddac880f1aaafedc6f2f
-  data.tar.gz: f1abac8e7d72762851395bfdd5dc397f6b1d7833
+  metadata.gz: 579a43d2967ed7592ae65d76b826b2a14b7dac14
+  data.tar.gz: 54a8f9846c685f2b0184d3dd8e2f9e95921b5fae
 SHA512:
-  metadata.gz: 385ee9c126906aa38936e02a74217f22f25b527d879ee882446b6cfbd890b6bf5433d6a4d5d34395b13d0d3c96fc317201c509aaad3247ab31dcca22e70aa3b1
-  data.tar.gz: f4bfe1ebffd9570f41ef05082addd694666c2400ec21cdfd362d54ed73cd8fe80c2bfd4e67f101eb5cc3f4fe003f61515e17d9ff2f3aafec9b955e9ff9eadb24
+  metadata.gz: 8b94570b37b186fdb35b3b875f1cad97e355a95d62df87ed179536f5792dd3ffeb88d55d4b9aba1622720dd2c50e10d5e50666b497264141518c63ee7ed00f96
+  data.tar.gz: 9903fe01ea858ad2605d38888bd5bdc4527e2eca195b780ad7f9627af4d478200e68e83080bd8a263f5bbbaa3b9ee8eb731b741933116f02b7fb7fc4ee8cfaa2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.2.0
+  - rbx-2
+  - ruby-head

data/README.md

@@ -1,6 +1,7 @@
 # ![Daigaku](http://res.cloudinary.com/daigaku-ruby/image/upload/c_scale,h_100/v1426946323/rect5481_si3rjr.png)
 
 [![Gem Version](https://badge.fury.io/rb/daigaku.svg)](http://badge.fury.io/rb/daigaku)
+[![Travis Build](https://travis-ci.org/daigaku-ruby/daigaku.svg)](https://travis-ci.org/daigaku-ruby/daigaku)
 
 Daigaku (大学) is the Japanese word for **university**.
 
@@ -36,29 +37,50 @@ 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 CLI screenshot](http://res.cloudinary.com/daigaku-ruby/image/upload/v1427558807/daigaku-cli-screenshot_xgpav6.png)
+
 ## 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.
 
+![Daigaku screen screenshot](http://res.cloudinary.com/daigaku-ruby/image/upload/v1430859202/daigaku-taskview_erwzrh.png)
+
 ## 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.
+Daigaku is a great tool, but it's nothing without courses to learn from.
+Go ahead and help with making Daigaku a worthwile and fun resource for learning Ruby!
+
+Daigaku uses the course "Get started with Ruby" by default.
+Any contributions to the basic Daigaku course are more than welcome.
+To add chapters to the course fork it from https://github.com/daigaku-ruby/Get_started_with_Ruby
+and follow its guidelines for adding chapters or units.
+
+You can also 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
 
+Any ideas, feature proposals, filing and feedback on issues are very welcome.
+We use the [git branching model](http://nvie.com/posts/a-successful-git-branching-model/) described by [nvie](https://github.com/nvie).
+
+Here's how to contribute:
+
 1. Fork it ( https://github.com/daigaku-ruby/daigaku/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Create your feature branch (`git checkout -b feature/my-new-feature develop`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
 5. Create a new Pull Request
 
+Please try to add RSpec tests with your new features. This will ensure that your code does not break existing functionality and that your feature is working as expected.
+
+Ah, don't forget step 6: Celebrate that you made Daigaku a better tool after your code was merged in! :octocat: :tada:
+
 ### License
 
 Daigaku is released under the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,2 +1,5 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/daigaku.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'daigaku/version'
@@ -6,10 +5,11 @@ require 'daigaku/version'
 Gem::Specification.new do |spec|
   spec.name          = "daigaku"
   spec.version       = Daigaku::VERSION
+  spec.required_ruby_version = '~> 2.0'
   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.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"
 
@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   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_runtime_dependency "quick_store", "~> 0.1.0"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/daigaku/configuration.rb

@@ -1,6 +1,5 @@
 module Daigaku
   require 'singleton'
-  require 'yaml'
   require 'fileutils'
 
   class Configuration
@@ -19,6 +18,10 @@ module Daigaku
       @courses_path = local_path_to(COURSES_DIR)
       @storage_file = local_path_to(STORAGE_FILE)
 
+      QuickStore.configure do |config|
+        config.file_path = @storage_file
+      end
+
       yield if block_given?
     end
 
@@ -48,13 +51,13 @@ module Daigaku
       settings.each do |variable|
         key = variable.to_s.delete('@')
         value = self.instance_variable_get(variable.to_sym)
-        Database.set(key, value)
+        QuickStore.store.set(key, value)
       end
     end
 
     def import!
-      @courses_path = Database.courses_path || @courses_path
-      @solutions_path = Database.solutions_path || @solutions_path
+      @courses_path = QuickStore.store.courses_path || @courses_path
+      @solutions_path = QuickStore.store.solutions_path || @solutions_path
       self
     end
 

data/lib/daigaku/congratulator.rb

@@ -0,0 +1,13 @@
+module Daigaku
+
+  class Congratulator
+
+    def self.message
+      lines = Terminal.text(:congratulations).lines.map(&:strip).compact
+      count = lines.count.zero? ? 0 : (lines.count - 1)
+      random_value = rand(0..count)
+      lines[random_value]
+    end
+
+  end
+end

data/lib/daigaku/course.rb

@@ -6,6 +6,7 @@ module Daigaku
     def initialize(path)
       @path = path
       @title = File.basename(path).gsub(/\_+/, ' ')
+      @author = QuickStore.store.get(key(:author))
     end
 
     def chapters
@@ -19,5 +20,9 @@ module Daigaku
     def mastered?
       chapters.reduce(true) { |mastered, chapter| mastered &&= chapter.mastered? }
     end
+
+    def key(key_name)
+      Storeable.key(title, prefix: 'courses', suffix: key_name)
+    end
   end
 end

data/lib/daigaku/generator.rb

@@ -5,15 +5,16 @@ module Daigaku
 
   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])
+      Dir[File.join(courses_path, "*/*/*/*.md")].each do |file|
+        content_dir_parts = file.split('/')[-4..-2].map do |part|
+          clean_up_path_part(part)
+        end
+
+        content_dir = File.join(content_dir_parts)
         directory = File.join(target_path, File.dirname(content_dir))
 
-        unit_name = File.basename(content_dir)
-        solution_file = unit_name.gsub(/(\_+|\-+|\.+)/, '_') + SOLUTION_SUFFIX
+        solution_file = File.basename(content_dir) + Solution::FILE_SUFFIX
         file_path = File.join(directory, solution_file)
 
         create_dir(directory)
@@ -49,5 +50,11 @@ module Daigaku
       create_dir(File.dirname(path))
       FileUtils.touch(path) unless File.exist?(path)
     end
+
+    def clean_up_path_part(text)
+      leading_numbers = /^\d+[\_\-\s]/
+      part_joints = /[\_\-\s]+/
+      text.gsub(leading_numbers, '').gsub(part_joints, '_').downcase
+    end
   end
 end

data/lib/daigaku/github_client.rb

@@ -0,0 +1,30 @@
+require 'open-uri'
+require 'json'
+require 'date'
+
+module Daigaku
+  module GithubClient
+
+    # Returns the url to the master zip file of the Github repo.
+    def self.master_zip_url(user_and_repo)
+      "https://github.com/#{user_and_repo}/archive/master.zip"
+    end
+
+    # Returns the timestamp of updated_at for the repo from the Github API.
+    def self.updated_at(user_and_repo)
+      url = "https://api.github.com/repos/#{user_and_repo}"
+      JSON.parse(open(url).read)['updated_at']
+    end
+
+    # Returns whether the pushed_at time from Github API is newer than the
+    # stored one.
+    def self.updated?(user_and_repo)
+      return false unless user_and_repo
+
+      course = Course.new(user_and_repo.split('/').last)
+      stored_time = QuickStore.store.get(course.key(:updated_at))
+      current_time = self.updated_at(user_and_repo)
+      DateTime.parse(stored_time) < DateTime.parse(current_time)
+    end
+  end
+end

data/lib/daigaku/reference_solution.rb

@@ -1,10 +1,18 @@
 module Daigaku
   class ReferenceSolution
-    attr_reader :code, :path
+    attr_reader :path
 
     def initialize(path)
       @path = Dir[File.join(path, '*solution.rb')].first
       @code = File.read(@path).strip if @path
     end
+
+    def code
+      @code.to_s
+    end
+
+    def code_lines
+      code.lines.map(&:chomp)
+    end
   end
-end
+end

data/lib/daigaku/solution.rb

@@ -1,18 +1,20 @@
 module Daigaku
   class Solution
 
+    FILE_SUFFIX = '_solution.rb'
+
     attr_reader :code, :path, :errors
 
     def initialize(unit_path)
       @unit_path = unit_path
       @path = solution_path(unit_path)
       @code = File.read(@path).strip if File.file?(@path)
-      @verified = get_database_state
+      @verified = get_store_state
     end
 
     def verify!
       result = Daigaku::Test.new(@unit_path).run(self.code)
-      set_database_state(result.passed?)
+      set_store_state(result.passed?)
       result
     end
 
@@ -20,23 +22,32 @@ module Daigaku
       !!@verified
     end
 
+    def store_key
+      unless @store_key
+        part_path = path.split('/')[-3..-1].join('/').gsub(FILE_SUFFIX, '')
+        @store_key = Storeable.key(part_path, prefix: 'verified')
+      end
+
+      @store_key
+    end
+
     private
 
     def solution_path(path)
       local_path = Daigaku.config.solutions_path
-      sub_dirs = path.split('/')[-3..-2]
-      file = File.basename(path).gsub(/(\_+|\-+|\.+)/, '_') + '_solution.rb'
+      sub_dirs = Storeable.key(path.split('/')[-3..-2].join('/').gsub(FILE_SUFFIX, ''))
+      file = Storeable.key(File.basename(path)) + FILE_SUFFIX
 
       File.join(local_path, sub_dirs, file)
     end
 
-    def set_database_state(verified)
+    def set_store_state(verified)
       @verified = verified
-      Daigaku.database.set(@path, verified?)
+      QuickStore.store.set(store_key, verified?)
     end
 
-    def get_database_state
-      Daigaku.database.get(@path)
+    def get_store_state
+      QuickStore.store.get(store_key)
     end
   end
 end

data/lib/daigaku/storeable.rb

@@ -0,0 +1,32 @@
+module Daigaku
+  module Storeable
+
+    LEADING_NUMBERS = /^\d+[\_\-\s]+/
+    PART_JOINTS = /[\_\-\s]+/
+
+    class << self
+      def key(text, options = {})
+        separator = QuickStore.config.key_separator
+        prefix = options[:prefix]
+        suffix = clean(options[:suffix])
+        suffixes = options[:suffixes]
+        suffixes_items = suffixes ? suffixes.map { |s| clean(s) }.compact : nil
+
+        [prefix, clean(text), suffix || suffixes_items].compact.join(separator)
+      end
+
+      private
+
+      def clean(text)
+        if text
+          parts = text.to_s.split(QuickStore.config.key_separator).map do |key|
+            key.gsub(LEADING_NUMBERS, '').gsub(PART_JOINTS, '_').downcase
+          end
+
+          parts.join(QuickStore.config.key_separator)
+        end
+      end
+    end
+
+  end
+end

data/lib/daigaku/terminal/courses.rb

@@ -15,15 +15,12 @@ module Daigaku
         say_info courses_list_text(courses)
       end
 
-      method_option :github,
-                    type: :string,
-                    aliases: '-g',
-                    desc: 'Download Github repository'
+      method_option :github, type: :string, aliases: '-g', desc: 'Download Github repository'
       desc 'download [URL] [OPTIONS]', 'Download a new daigaku course from [URL]'
-      def download(url = nil)
+      def download(url = nil, action = 'downloaded')
         use_initial_course = url.nil? && options[:github].nil?
-        url = github_repo(Daigaku.config.initial_course) if use_initial_course
-        url = github_repo(options[:github]) if options[:github]
+        url = GithubClient.master_zip_url(Daigaku.config.initial_course) if use_initial_course
+        url = GithubClient.master_zip_url(options[:github]) if options[:github]
 
         url_given = (url =~ /\A#{URI::regexp(['http', 'https'])}\z/)
         github = use_initial_course || options[:github] || url.match(/github\.com/)
@@ -38,9 +35,18 @@ module Daigaku
 
         File.open(file_name, 'w') { |file| file << open(url).read }
         course_name = unzip(file_name, github)
+
+        if github
+          user_and_repo = url.match(/github.com\/(.*)\/archive\/master.zip/).captures.first
+          store_repo_data(options[:github] || user_and_repo)
+        end
+
+        course = Course.new(course_name)
+        QuickStore.store.set(course.key(:url), url)
+        QuickStore.store.set(course.key(:updated_at), Time.now.to_s)
         scaffold_solutions
 
-        say_info "Successfully downloaded the course \"#{course_name}\"!"
+        say_info "Successfully #{action} the course \"#{course_name}\"!"
       rescue Download::NoUrlError => e
         print_download_warning(url, "\"#{url}\" is not a valid URL!")
       rescue Download::NoZipFileUrlError => e
@@ -51,6 +57,58 @@ module Daigaku
         FileUtils.rm(file_name) if File.exist?(file_name.to_s)
       end
 
+      method_option :all, type: :boolean, aliases: '-a', desc: 'Update all courses'
+      desc 'update [COURSE_NAME] [OPTIONS]', 'Update Daigak courses.'
+      def update(course_name = nil)
+        if options[:all]
+          courses = Loading::Courses.load(Daigaku.config.courses_path)
+          courses.each { |course| update_course(course) }
+        elsif course_name
+          path = File.join(Daigaku.config.courses_path, course_name)
+
+          unless Dir.exist?(path)
+            print_course_not_available(course_name)
+            return
+          end
+
+          update_course(Course.new(course_name))
+        else
+          system 'daigaku course help update'
+        end
+      end
+
+      method_option :all, type: :boolean, aliases: '-a', desc: 'Delete all courses'
+      desc 'delete [COURSE_NAME] [OPTIONS]', 'Delete Daigaku courses.'
+      def delete(course_name = nil)
+        if options[:all]
+          get_confirm('Are you shure you want to delete all courses?') do
+            course_dirs = Dir[File.join(Daigaku.config.courses_path, '*')]
+
+            course_dirs.each do |dir|
+              FileUtils.remove_dir(dir)
+              QuickStore.store.delete(Storeable.key(File.basename(dir), prefix: 'courses'))
+            end
+
+            say_info "All daigaku courses were successfully deleted."
+          end
+        elsif course_name
+          path = File.join(Daigaku.config.courses_path, course_name)
+
+          unless Dir.exist?(path)
+            print_course_not_available(course_name)
+            return
+          end
+
+          get_confirm("Are you shure you want to delete the course \"#{course_name}\"?") do
+            FileUtils.remove_dir(path)
+            QuickStore.store.delete(Storeable.key(course_name, prefix: 'courses'))
+            say_info "The course \"#{course_name}\" was successfully deleted."
+          end
+        else
+          system 'daigaku courses help delete'
+        end
+      end
+
       private
 
       def courses_list_text(courses)
@@ -66,8 +124,14 @@ module Daigaku
         "#{text}\n#{Terminal.text :hint_course_download}"
       end
 
-      def github_repo(user_and_repo)
-        "https://github.com/#{user_and_repo}/archive/master.zip"
+      def store_repo_data(user_and_repo)
+        parts = (user_and_repo ||= Daigaku.config.initial_course).split('/')
+        author = parts.first
+        course = parts.second
+
+        course = Course.new(course)
+        QuickStore.store.set(course.key(:author), author)
+        QuickStore.store.set(course.key(:github), user_and_repo)
       end
 
       def unzip(file_path, github = false)
@@ -84,7 +148,10 @@ module Daigaku
               directory = entry.to_s
             end
 
-            course_name ||= directory.split('/').first.gsub(/_+/, ' ')
+            if directory != '/'
+              course_name ||= directory.split('/').first.gsub(/_+/, ' ')
+            end
+
             zip_file.extract(entry, "#{target_dir}/#{directory}") { true }
           end
         end
@@ -108,6 +175,31 @@ module Daigaku
 
         say_warning message
       end
+
+      def update_course(course)
+        url = QuickStore.store.get(course.key(:url))
+        github_repo = QuickStore.store.get(course.key(:github))
+        updated = GithubClient.updated?(github_repo)
+
+        if !github_repo || updated
+          download(url, 'updated') if url
+        else
+          say_info "Course \"#{course.title}\" is still up to date."
+        end
+      end
+
+      def print_course_not_available(course_name)
+        text = [
+          "The course \"#{course_name}\" is not available in",
+          "\"#{Daigaku.config.courses_path}\".\n",
+        ]
+
+        say_warning text.join("\n")
+
+        unless Loading::Courses.load(Daigaku.config.courses_path).empty?
+          Terminal::Courses.new.list
+        end
+      end
     end
 
   end

data/lib/daigaku/terminal/output.rb

@@ -65,6 +65,12 @@ module Daigaku
             break
           end
         end
+
+        def get_confirm(description)
+          say_warning description
+          confirm = get '(yes|no)'
+          yield if confirm == 'yes' && block_given?
+        end
       end
     end
 

data/lib/daigaku/terminal/texts/congratulations.txt

@@ -0,0 +1,12 @@
+Well done!
+Three cheers!
+You did it!
+Congrats!
+Bravo!
+Hip, hip, hurrah!
+Congratulations!
+Kudos!
+Props!
+Hats off!
+Yay!
+Well done! Ready for the next task?

data/lib/daigaku/terminal.rb

@@ -4,7 +4,8 @@ module Daigaku
     # text should be of a width of 70 columns or less
     def self.text(file_name)
       texts_path = File.expand_path('../terminal/texts', __FILE__)
-      File.read(File.join(texts_path, "#{file_name.to_s}.txt"))
+      file = File.join(texts_path, "#{file_name.to_s}.txt")
+      (File.exist?(file) ? File.read(file).to_s : '')
     end
 
   end

data/lib/daigaku/test_result.rb

@@ -5,8 +5,6 @@ module Daigaku
 
     attr_reader :examples, :example_count, :failure_count
 
-    TEST_PASSED_MESSAGE = "Your code passed all tests. Congratulations!"
-
     def initialize(result_json)
       @result = begin
         JSON.parse(result_json, symbolize_names: true)
@@ -35,12 +33,16 @@ module Daigaku
 
     def summary
       if passed?
-        TEST_PASSED_MESSAGE
+        "Your code passed all tests. #{Daigaku::Congratulator.message}"
       else
         build_failed_summary
       end
     end
 
+    def summary_lines
+      summary.lines.map(&:strip)
+    end
+
     private
 
     def build_failed_summary

data/lib/daigaku/version.rb

@@ -1,3 +1,3 @@
 module Daigaku
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end