daigaku 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9c6f1f336e0af615495359124f476852ef7dfa36
-  data.tar.gz: 2baf4a0586e8b933fb30cd9af7bbe2be9a3fe983
+SHA256:
+  metadata.gz: 3d2569151b28f6803d8c351ad6c131e13d741c7515a08e3d6e5ff2db007d085b
+  data.tar.gz: d53b84a072e46320f7e4555c00ba3955e9de81a0729037257c4c41e217e72c67
 SHA512:
-  metadata.gz: 537a9fa9742cda1129165bf8f0a163213d415fd3d6f221e93c54244f6a0eb379451146ba9e4e7f094c705416e9aef9f6ed350e9b849030fa6cba0278ac33eb19
-  data.tar.gz: c4a943a667fd22f0d420838ee6f83cac333613b4740ba889d3a24b8b32e989ca63813ab80206bd2aa8afb1429cc739a3f9717c07d9dc2ba3a9818b93794b1198
+  metadata.gz: c3d43f800a282522f4cae4550e56785e92b1feee01f179306e5022e81223716437fd2b3b813adb37328d9d6b835cfafacd6842de8d7db5c8cbe05c4703deb4ad
+  data.tar.gz: 6373c4ae4ba47cb9ae150d5048b16898b98cf4e768d8f70b9f46d406e2b6951e0e4d260b141fe85e5602007be44dc92f55b25a3763000e81b366d55534e786c0

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
+
+before_install:
+  - gem install bundler
+
 rvm:
-  - 2.0.0
-  - 2.2.0
-  - rbx-2
-  - ruby-head
+  - 2.5.0
+  - 2.6.0
+  - 2.7.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at paul.christoph.goetze@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

data/README.md

@@ -1,4 +1,4 @@
-# ![Daigaku](http://res.cloudinary.com/daigaku-ruby/image/upload/c_scale,h_100/v1426946323/rect5481_si3rjr.png)
+# ![Daigaku](https://res.cloudinary.com/paulgoetze/image/upload/v1520762114/daigaku/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)
@@ -16,7 +16,7 @@ language-explaining programming tasks.
 ## Installation
 
 First of all make sure Ruby is installed on your computer.
-Daigaku works with [MRI Ruby](https://www.ruby-lang.org/en/documentation/installation/) v2.x and [Rubinius](http://rubini.us/doc/en/getting-started/) v2.x.
+Daigaku works with [MRI Ruby](https://www.ruby-lang.org/en/documentation/installation/) v2.5 or higher.
 
 Then open a terminal and install Daigaku by running:
 
@@ -32,34 +32,34 @@ Daigaku will lead you through the setup and some important commands.
 
 ## Command line interface
 
-Daigaku's command line interface provides several commands which you
+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 CLI screenshot](http://res.cloudinary.com/daigaku-ruby/image/upload/v1427558807/daigaku-cli-screenshot_xgpav6.png)
+![Daigaku CLI screenshot](https://res.cloudinary.com/paulgoetze/image/upload/v1520762037/daigaku/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.
+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)
+![Daigaku screen screenshot](https://res.cloudinary.com/paulgoetze/image/upload/v1520762097/daigaku/daigaku-task-view_zbvsia.png)
 
 ## Contributing
 
 We encourage you to contribute to Daigaku development and course creation.
 
-This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant code of conduct](http://contributor-covenant.org/version/1/2/0).
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant Code of Conduct](https://github.com/daigaku-ruby/daigaku/blob/master/CODE_OF_CONDUCT.md).
 
 ### Creating Daigaku courses
 
-Daigaku is a great tool, but it's nothing without courses to learn from.
+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.
+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.
@@ -72,7 +72,7 @@ Learn how to create a Daigaku course in the [Daigaku Wiki](https://github.com/da
 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:
+Here’s how to contribute:
 
 1. Fork it ( https://github.com/daigaku-ruby/daigaku/fork )
 2. Create your feature branch (`git checkout -b feature/my-new-feature develop`)
@@ -82,7 +82,7 @@ Here's how to contribute:
 
 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:
+Ah, don’t forget step 6: Celebrate that you made Daigaku a better tool after your code was merged in! :octocat: :tada:
 
 ### License
 

data/bin/daigaku

@@ -6,7 +6,11 @@ begin
   require 'daigaku'
 rescue LoadError => e
   warn "could not load \"daigaku\"\n#{e}"
-  exit -1
+  exit(-1)
 end
 
-Daigaku::Terminal::CLI.start
+begin
+  Daigaku::Terminal::CLI.start
+rescue Interrupt
+  puts "\n\n\t👋 See you soon!"
+end

data/daigaku.gemspec

@@ -3,37 +3,33 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'daigaku/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "daigaku"
+  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.homepage      = "https://github.com/daigaku-ruby/daigaku"
-  spec.license       = "MIT"
-
+  spec.authors       = ['Paul Götze']
+  spec.email         = ['paul.christoph.goetze@gmail.com']
+  spec.summary       = 'Learning Ruby on the command line.'
+  spec.description   = '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"]
+  spec.require_paths = ['lib']
 
-  if RUBY_VERSION >= '2.1'
-    spec.add_runtime_dependency "curses", "~> 1.0"
-  end
+  spec.required_ruby_version = '>= 2.5'
 
-  spec.add_runtime_dependency "activesupport", "~> 4.0"
-  spec.add_runtime_dependency "rspec", "~> 3.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"
-  spec.add_runtime_dependency "wisper", "~> 2.0.0.rc1"
-  spec.add_runtime_dependency "quick_store", "~> 0.1"
-  spec.add_runtime_dependency "code_breaker", "~> 0.1"
+  spec.add_runtime_dependency 'curses',        '~> 1.3'
+  spec.add_runtime_dependency 'rspec',         '~> 3.0'
+  spec.add_runtime_dependency 'thor',          '~> 1.0'
+  spec.add_runtime_dependency 'os',            '~> 1.0'
+  spec.add_runtime_dependency 'colorize',      '~> 0.8'
+  spec.add_runtime_dependency 'rubyzip',       '~> 2.0'
+  spec.add_runtime_dependency 'wisper',        '~> 2.0'
+  spec.add_runtime_dependency 'quick_store',   '~> 1.0'
+  spec.add_runtime_dependency 'code_breaker',  '~> 1.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"
+  spec.add_development_dependency 'bundler',     '~> 2.0'
+  spec.add_development_dependency 'rake',        '~> 13.0'
+  spec.add_development_dependency 'webmock',     '~> 3.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
 end

data/lib/daigaku.rb

@@ -6,7 +6,6 @@ Dir[File.join("#{File.dirname(__FILE__)}/**/*.rb")].sort.each do |file|
 end
 
 module Daigaku
-
   class << self
     def config
       Configuration.instance

data/lib/daigaku/chapter.rb

@@ -1,10 +1,9 @@
 module Daigaku
   class Chapter
-
     attr_reader :title, :path
 
     def initialize(path)
-      @path = path
+      @path  = path
       @title = File.basename(path).gsub(/\_+/, ' ')
     end
 
@@ -13,11 +12,11 @@ module Daigaku
     end
 
     def started?
-      units.reduce(false) { |started, unit| started ||= unit.mastered? }
+      units.any?(&:mastered?)
     end
 
     def mastered?
-      units.reduce(true) { |mastered, unit| mastered &&= unit.mastered? }
+      units.all?(&:mastered?)
     end
   end
 end

data/lib/daigaku/coloring.rb

@@ -1,37 +1,32 @@
 require 'curses'
-require 'active_support/concern'
 
 module Daigaku
   module Coloring
-    extend ActiveSupport::Concern
+    COLOR_TEXT           = Curses::COLOR_YELLOW  unless defined? COLOR_TEXT
+    COLOR_TEXT_EMPHASIZE = Curses::COLOR_CYAN    unless defined? COLOR_TEXT_EMPHASIZE
+    COLOR_HEADING        = Curses::COLOR_WHITE   unless defined? COLOR_HEADING
+    COLOR_RED            = Curses::COLOR_BLUE    unless defined? COLOR_RED
+    COLOR_GREEN          = Curses::COLOR_MAGENTA unless defined? COLOR_GREEN
+    COLOR_YELLOW         = Curses::COLOR_RED     unless defined? COLOR_YELLOW
 
-    included do
-      COLOR_TEXT = Curses::COLOR_YELLOW         unless defined? COLOR_TEXT
-      COLOR_TEXT_EMPHASIZE = Curses::COLOR_CYAN unless defined? COLOR_TEXT_EMPHASIZE
-      COLOR_HEADING = Curses::COLOR_WHITE       unless defined? COLOR_HEADING
-      COLOR_RED = Curses::COLOR_BLUE            unless defined? COLOR_RED
-      COLOR_GREEN = Curses::COLOR_MAGENTA       unless defined? COLOR_GREEN
-      COLOR_YELLOW = Curses::COLOR_RED          unless defined? COLOR_YELLOW
+    BACKGROUND           = Curses::COLOR_WHITE   unless defined? BACKGROUND
+    FONT                 = Curses::COLOR_BLACK   unless defined? FONT
+    FONT_HEADING         = Curses::COLOR_MAGENTA unless defined? FONT_HEADING
+    FONT_EMPHASIZE       = Curses::COLOR_BLUE    unless defined? FONT_EMPHASIZE
+    RED                  = Curses::COLOR_RED     unless defined? RED
+    GREEN                = Curses::COLOR_GREEN   unless defined? GREEN
+    YELLOW               = Curses::COLOR_YELLOW  unless defined? YELLOW
 
-      BACKGROUND = Curses::COLOR_WHITE          unless defined? BACKGROUND
-      FONT = Curses::COLOR_BLACK                unless defined? FONT
-      FONT_HEADING = Curses::COLOR_MAGENTA      unless defined? FONT_HEADING
-      FONT_EMPHASIZE = Curses::COLOR_BLUE       unless defined? FONT_EMPHASIZE
-      RED = Curses::COLOR_RED                   unless defined? RED
-      GREEN = Curses::COLOR_GREEN               unless defined? GREEN
-      YELLOW = Curses::COLOR_YELLOW             unless defined? YELLOW
+    protected
 
-      protected
-
-      def init_colors
-        Curses.start_color
-        Curses.init_pair(COLOR_TEXT, FONT, BACKGROUND)
-        Curses.init_pair(COLOR_TEXT_EMPHASIZE, FONT_EMPHASIZE, BACKGROUND)
-        Curses.init_pair(COLOR_HEADING, FONT_HEADING, BACKGROUND)
-        Curses.init_pair(COLOR_RED, RED, BACKGROUND)
-        Curses.init_pair(COLOR_GREEN, GREEN, BACKGROUND)
-        Curses.init_pair(COLOR_YELLOW, YELLOW, BACKGROUND)
-      end
+    def init_colors
+      Curses.start_color
+      Curses.init_pair(COLOR_TEXT, FONT, BACKGROUND)
+      Curses.init_pair(COLOR_TEXT_EMPHASIZE, FONT_EMPHASIZE, BACKGROUND)
+      Curses.init_pair(COLOR_HEADING, FONT_HEADING, BACKGROUND)
+      Curses.init_pair(COLOR_RED, RED, BACKGROUND)
+      Curses.init_pair(COLOR_GREEN, GREEN, BACKGROUND)
+      Curses.init_pair(COLOR_YELLOW, YELLOW, BACKGROUND)
     end
   end
 end

data/lib/daigaku/configuration.rb

@@ -1,15 +1,15 @@
-module Daigaku
-  require 'singleton'
-  require 'fileutils'
+require 'singleton'
+require 'fileutils'
 
+module Daigaku
   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'
+    LOCAL_DIR              = '.daigaku'.freeze
+    COURSES_DIR            = 'courses'.freeze
+    SOLUTIONS_DIR          = 'solutions'.freeze
+    STORAGE_FILE           = 'daigaku.db.yml'.freeze
+    DAIGAKU_INITIAL_COURSE = 'daigaku-ruby/Get_started_with_Ruby'.freeze
 
     attr_accessor :courses_path
     attr_reader :storage_file
@@ -26,52 +26,50 @@ module Daigaku
     end
 
     def solutions_path
-      @solutions_path || raise(Daigaku::ConfigurationError, 'Solutions path is not set.')
+      @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 = [
+        raise(
           Daigaku::ConfigurationError,
-          "Solutions path \"#{path}\" isn't an existing directory."
-        ]
-
-        raise(*error)
+          "Solutions path \"#{path}\" isn’t an existing directory."
+        )
       end
 
       @solutions_path = full_path
     end
 
     def save
-      settings = self.instance_variables
+      settings = instance_variables
       settings.delete(:@storage_file)
 
       settings.each do |variable|
-        key = variable.to_s.delete('@')
-        value = self.instance_variable_get(variable.to_sym)
+        key   = variable.to_s.delete('@')
+        value = instance_variable_get(variable.to_sym)
         QuickStore.store.set(key, value)
       end
     end
 
-    def import!
-      @courses_path = QuickStore.store.courses_path || @courses_path
-      @solutions_path = QuickStore.store.solutions_path || @solutions_path
+    def import
+      store           = QuickStore.store
+      @courses_path   = store.courses_path || @courses_path
+      @solutions_path = store.solutions_path || @solutions_path
       self
     end
 
     def summary
-      settings = self.instance_variables
+      settings = 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}"
+      settings.reduce('') do |lines, variable|
+        key   = variable.to_s.delete('@').tr('_', ' ')
+        value = instance_variable_get(variable.to_sym)
+        lines + "* #{key}: #{value}\n"
       end
-
-      lines.join("\n")
     end
 
     def initial_course
@@ -85,5 +83,4 @@ module Daigaku
       File.expand_path(path, __FILE__)
     end
   end
-
 end