ruby_learner 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e682d333421ae9da8e3dd5a3d833550951e62506
-  data.tar.gz: 5d93a9ae88365f89820966ce0fc37b6ac9e3646b
+  metadata.gz: 056f2ac0ca82ec04cb0f6ada2bc499805b5f1c87
+  data.tar.gz: d67df5fe08c6ac72d5f9b62c7d71506e7e433a70
 SHA512:
-  metadata.gz: 406ce0b5d8b414a8d21009fd8f409601af4cc6396e6663b48430a24154b182d576bcc885c1b498fe92d346c89935edd3fa13a944c7cbf5e1c9bad5e1c9493155
-  data.tar.gz: 89d9766d26fab257735d1debf57390c6b252e9d93d7e4f7d0ad27c9002592c8ffa2f7544e6175652c585982323ba864002b22932ae8e836c622a542f9c6f71e5
+  metadata.gz: 6c951efb79e5187af6b1ab147f61704b0cf57381da496b0dd8e64712a68c3e7b93ba5209f378f5f797fe78c5446c625095302b329257f496bd1830ff69b7878c
+  data.tar.gz: 7ee76703139ef6715edfb1c059519df5fdb85d54d94544f97741ce96e52612ccfff2369396589f8e723cc944daec878ed53fad8d763d773a1302030273d88ef3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_learner (1.1.1)
+    ruby_learner (1.1.2)
       colorize
       diff-lcs
       minitest (~> 5.10.3)

data/docs/thesis/competing_services.org

@@ -0,0 +1,21 @@
+#+STARTUP: indent nolineimages
+* ドットインストール
+** 料金形態
+** 自身のコード記入について
+** 言語の教育方法
+** 使用者が得れるもの
+* paizaラーニング
+** 料金形態
+** 自身のコード記入について
+** 言語の教育方法
+** 使用者が得れるもの
+* progate
+** 料金形態
+** 自身のコード記入について
+** 言語の教育方法
+** 使用者が得れるもの
+* codecademy
+** 料金形態
+** 自身のコード記入について
+** 言語の教育方法
+** 使用者が得れるもの

data/docs/thesis/manual.org

@@ -0,0 +1,55 @@
+#+STARTUP: indent nolineimages
+* app
+- ruby_learner
+* install
+- gem install ruby_learner
+** 注意点
+- 作成者の知識不足から、アプリのバージョンアップ時に古いバージョンが残った状態になっている。それが原因で起動エラーが起こる可能性があるので、その場合のエラー解消方法を以下に記載する。
+- gem list ruby_learner
+- gem uninstall ruby_learner
+* purpose
+- プログラミング言語Rubyを実際の開発環境に近い状況で習得させること。 
+- 習得のレベルは"期待される振る舞いの実装"および"設定より規約の考えの元、適切なコーディングができる"に設定。
+- 開発環境に近い状況での開発は、使用者の本アプリ外での学習や開発をスムーズにさせる。
+* target
+- プログラミング言語Rubyの未経験者。
+* overview
+** 期待される振る舞いについて
+- 期待される振る舞いとは、コーダーがコードに持たせる意図する動作のことである。
+- コードの振る舞いを確認するrspecファイルを用いることで、使用者は解答方法を柔軟に考えることができる。これは期待される振る舞いを実現するコードに唯一の正解はないことから、回答は使用者自身が考えて記述することでより効率的な学習が見込めるのではないかという理由から選択した。
+** 設定より規約について
+- 設定より規約とは、開発者の決定すべきことを減少させ、単純にするが柔軟性は失わせないというソフトウェア設計の概念である。<wikipedia: https://ja.wikipedia.org/wiki/%E8%A8%AD%E5%AE%9A%E3%82%88%E3%82%8A%E8%A6%8F%E7%B4%84>
+- 設定より規約はrubocopを用いることで検査する。設定より規約の概念を重視することで、OSS開発等の複数人で開発を行う場合にスムーズな開発が行える。また、不適切はコードは使用者の成長を間違った方向に進めつ可能性があるのでこの検査は必須だと考える。
+* function
+** common
+- 本アプリは使用者のパソコンのホームディレクトリにruby_learnerというディレクトリを形成する。
+- ruby_learnerに含まれる要素はemacsの設定ファイル・学習を行う場所のworkshop・学習の履歴を保存するrestoreである。
+- 今までの自分の回答コードはworkshopのrestoreに保存されて行く
+** emacs_key
+*** 使用コマンド
+- emacsのキーバインドの確認: ruby_learner emacs_key
+** sequential_check
+*** 使用コマンド
+- 任意のドリルの受講: ruby_learner sequential_check section part (sectionとpartには整数が入る)
+- 次のドリルの受講: ruby_learner sequential_check -next
+- ドリルの内訳の確認: ruby_learner sequential_check -drill
+*** 学習手順
+**** 手順１
+- 任意のコマンドで実行
+- 問題文とコード記入スペースがemacsで起動
+**** 手順２
+- 回答を記入する
+- ctrl x + ctrl cでemacsを保存終了する
+**** 手順３
+- rspecのチェックが行われる
+- 不適切な場合は改善を要求される
+- cotinue, answer, exitの3つを標準入力で打ち込むことで次の画面が変わる
+- continue...問題文とコード記入スペースがemacsで起動して手順２に戻る
+- answer...問題文とコード記入スペースと解答例がemacsで起動して手順２に戻る
+- exit...アプリを終了
+**** 手順４
+- rspecのチェックが終了すると
+- rubocopのチェックもrspecのチェックと同様に始まる
+**** 手順５
+- rubocopのチェックが終わると
+- 最後にrspecのチェックが行われ、不適切な場合は手順３へと戻る

data/lib/ruby_learner/common.rb

@@ -0,0 +1,45 @@
+class Common
+  def restore(file: String, workshop_dir: String)
+  restore_file = ""
+    line = File.open("#{workshop_dir}/lib/answer.rb") do |f|
+      1.times {
+        f.gets
+      }
+      restore_file = f.gets
+    end
+    restore_file.gsub!(" ", "")
+    restore_file.delete!("#")
+    Dir::chdir("#{workshop_dir}/restore"){
+      file_count = Dir.glob("*.rb").count
+      # restore_file.insert(-5, "[#{file_count}]")
+      restore_file.insert(0, "[#{file_count}]")
+    }
+    system "touch #{workshop_dir}/restore/#{restore_file}"
+    system "cp #{workshop_dir}/lib/workplace.rb #{workshop_dir}/restore/#{restore_file}"
+  end
+
+  def time_check(start_time: Time)
+    end_time = Time.now
+    elapsed_time = end_time - start_time - 1
+    return elapsed_time
+  end
+
+  def instruct_print
+    puts "continue >>> [RET]"
+    puts "stop >>> 'exit' + [RET]"
+    puts "check answer >>> 'answer' + [RET]"
+  end
+  def init_mk_files(gem_dir: String, workshop_dir: String)
+    if Dir.exist?(workshop_dir) != true then
+      FileUtils.mkdir_p(workshop_dir)
+      system("cp -R #{gem_dir}/workshop/* #{workshop_dir}")
+      system("cd #{workshop_dir} && mv emacs.d .emacs.d")
+    end
+  end
+  
+  def get_app_ver(app_name: String)
+    app_vers = Open3.capture3("gem list #{app_name}")
+    latest_ver = app_vers[0].chomp.gsub(' (', '-').gsub(')','')
+    return latest_ver
+  end
+end

data/lib/ruby_learner/ruby_learner.rb

@@ -1,11 +1,9 @@
 require 'fileutils'
-require 'colorize'
 require 'thor'
 require 'ruby_learner/version.rb'
-require 'diff-lcs'
 require 'open3'
-require 'ruby_learner/methods.rb'
-require 'ruby_learner/typing_practice.rb'
+require 'ruby_learner/common.rb'
+require 'ruby_learner/sequential_main'
 
 module RubyLearner
   # editor_learner CLI main class
@@ -17,7 +15,7 @@ module RubyLearner
       app_vers = Open3.capture3('gem list ruby_learner')
       rl_ver = app_vers[0].chomp.tr(' ', '-').delete('()')
       @gem_dir = File.join(gem_location[0].chomp, "/gems/#{rl_ver}")
-      init_mk_files(gem_dir: @gem_dir, workshop_dir: @workshop_dir)
+      Common.allocate.init_mk_files(gem_dir: @gem_dir, workshop_dir: @workshop_dir)
     end
 
     desc 'emacs_key', 'check emacs key-bindings'
@@ -29,23 +27,17 @@ module RubyLearner
     option :next, aliases: "-n", type: :boolean
     option :drill, aliases: "-d", type: :boolean
     def sequential_check(*_argv, dir_num, file_num)
+      sequential_main = SequentialMain.new(@gem_dir, @workshop_dir)
       if options[:drill]
-        drill_contents
+        sequential_main.drill_contents
       elsif options[:next]
-        final_sec, final_par = final_history(@gem_dir)
-        next_sec, next_par = next_question(final_sec, final_par)
-        sequential_check_main(@gem_dir, @workshop_dir, next_sec, next_par)
+        final_sec, final_par = sequential_main.get_final_history(@gem_dir)
+        next_sec, next_par = sequential_main.get_next_question(final_sec, final_par)
+        sequential_main.action(next_sec, next_par)
       else
-        sequential_check_main(@gem_dir, @workshop_dir, dir_num, file_num)
+        sequential_main.action(dir_num, file_num)
       end
     end
 
-    desc 'random_check', 'typing and editing practice.'
-    def random_check
-      rand_num = rand(1..2)
-      rand_dir = "#{@gem_dir}/questions/random_check/section_#{rand_num}"
-      typing_practice = TypingPractice.new(workshop_dir: @workshop_dir)
-      typing_practice.prac_sequence(mode_dir: rand_dir)
-    end
   end
 end

data/lib/ruby_learner/sequential_main.rb

@@ -0,0 +1,146 @@
+require 'ruby_learner/typing_practice'
+
+class SequentialMain
+
+  def initialize(gem_dir, workshop_dir)
+    @gem_dir = gem_dir
+    @workshop_dir = workshop_dir
+  end
+
+  def action(sec, par)
+    puts "section_#{sec}/part_#{par}"
+    seq_dir = "#{@gem_dir}/questions/sequential_check/section_#{sec}/part_#{par}"
+    typing_prac_class = TypingPractice.new(@workshop_dir, @gem_dir)
+    typing_prac_class.prac_sequence(mode_dir: seq_dir)
+    write_final_history(sec, par)
+  end
+
+  def write_final_history(sec, par)
+    docs_dir = "#{@gem_dir}/lib/datas"
+    Dir::chdir(docs_dir){
+      File.open("final_history_sequential.txt","w") do |f|
+        f.puts("#{sec}-#{par}")
+      end
+    }
+  end
+
+  def drill_contents
+    puts "section_1  1~3"
+    puts "section_2  1~2"
+    puts "section_3  1"
+    puts "section_4  1"
+    puts "section_5  1~2"
+    puts "section_6  1~4"
+    puts "section_7  1~2"
+    puts "section_8  1"
+    puts "section_9  1~3"
+    puts "section_10 1~2"
+    puts "section_11 1~2"
+  end
+  
+  def get_final_history(gem_dir)
+    docs_dir = "#{gem_dir}/lib/datas"
+    final_history = ''
+    final_sec = 0
+    final_par = 0
+    Dir::chdir(docs_dir){
+      File.open("final_history_sequential.txt") do |f|
+      final_history = f.gets
+      end
+      final_sec = final_history.match(/(.*)\-/)[1].to_i
+      final_par = final_history.match(/\-(.*)/)[1].to_i
+    }
+    return final_sec, final_par
+  end
+  
+  def get_next_question(final_sec, final_par)
+    if final_sec == 1
+    if final_par == 1
+      next_sec = 1
+      next_par = 2
+    elsif final_par == 2
+      next_sec = 1
+      next_par = 3
+    else
+      next_sec = 2
+      next_par = 1
+    end
+    elsif final_sec == 2
+      if final_par == 1
+        next_sec = 2
+        next_par = 2
+      else
+        next_sec = 3
+        next_par = 1
+      end
+    elsif final_sec == 3
+      next_sec = 4
+      next_par = 1
+    elsif final_sec == 4
+      next_sec = 5
+      next_par = 1
+    elsif final_sec == 5
+      if final_par == 1
+        next_sec = 5
+        next_par = 2
+      else
+        next_sec = 6
+        next_par = 1
+      end
+    elsif final_sec == 6
+      if final_par == 1
+        next_sec = 6
+        next_par = 2
+      elsif final_par == 2
+        next_sec = 6
+        next_par = 3
+      elsif final_par == 3
+        next_sec = 6
+        next_par = 4
+      else
+        next_sec = 7
+        next_par = 1
+      end
+    elsif final_sec == 7
+      if final_par == 1
+        next_sec = 7
+        next_par = 2
+      else
+        next_sec = 8
+        next_par = 1
+      end
+    elsif final_sec == 8
+      next_sec = 9
+      next_par = 1
+    elsif final_sec == 9
+      if final_par == 1
+        next_sec = 9
+        next_par = 2
+      elsif final_par == 2
+        next_sec = 9
+        next_par = 3
+      else
+        next_sec = 10
+        next_par = 1
+      end
+    elsif final_sec == 10
+      if final_par == 1
+        next_sec = 10
+        next_par = 2
+      else
+        next_sec = 11
+        next_par = 1
+      end
+    else
+      if final_par == 1
+        next_sec = 11
+        next_par = 2
+      else
+        next_sec = 1
+        next_par = 1
+      end
+    end
+    return next_sec, next_par
+  end
+  
+end

data/lib/ruby_learner/typing_practice.rb

@@ -1,15 +1,14 @@
 require 'fileutils'
-require 'ruby_learner/methods.rb'
+require 'ruby_learner/common.rb'
+require 'rubocop'
 
 class TypingPractice
 
-  def initialize(workshop_dir: String)
+  def initialize(workshop_dir, gem_dir)
     @workshop_dir = workshop_dir
-    gem_location = Open3.capture3('gem environment gemdir')
-      app_vers = Open3.capture3('gem list ruby_learner')
-      rl_ver = app_vers[0].chomp.tr(' ', '-').delete('()')
-      @gem_dir = File.join(gem_location[0].chomp, "/gems/#{rl_ver}")
-  end
+    @gem_dir = gem_dir
+   end
+
   def prac_sequence(mode_dir: String)
     FileUtils.cp("#{mode_dir}/lib/workplace.rb", "#{@workshop_dir}/lib/workplace.rb")
     FileUtils.cp("#{mode_dir}/lib/sentence.org", "#{@workshop_dir}/lib/sentence.org")
@@ -17,9 +16,82 @@ class TypingPractice
     FileUtils.cp("#{mode_dir}/spec/workplace_spec.rb", "#{@workshop_dir}/spec/workplace_spec.rb")
     system "cd #{@workshop_dir}/lib && emacs -nw -q -l #{@workshop_dir}/.emacs.d/init.el sentence.org workplace.rb"
     start_time = Time.now
-    typing_discriminant(@workshop_dir)
-    elapsed_time = time_check(start_time: start_time)
+    typing_discriminant
+    elapsed_time = Common.allocate.time_check(start_time: start_time)
     p "#{elapsed_time} sec"
-    # mk_training_data(elapsed_time: elapsed_time, prac_dir: @prac_dir)
   end
+
+  def typing_discriminant
+    loop do
+      flag_rspec, flag_rs_exit = rspec_check
+      if flag_rs_exit == true
+        break
+      end
+      flag_rubocop, flag_rub_exit = rubocop_check
+      if flag_rub_exit == true
+        break
+      end
+      if flag_rspec == true && flag_rubocop == true
+        puts "**********************************"
+        puts "Final Error Check"
+        puts "**********************************"
+        stdout, stderr, status = Open3.capture3("rspec #{@workshop_dir}/spec/workplace_spec.rb")
+        if stdout[0] == '.'
+          puts "your code is perfect."
+          puts 'If you want to run your code, you execute the following command.'
+          puts " $ ruby #{@workshop_dir}/lib/workplace.rb"
+          break
+        else
+          puts "not perfect, please fix your code."
+        end
+      end
+    end
+    Common.allocate.restore(file: "#{@workshop_dir}/lib/workplace.rb", workshop_dir: @workshop_dir)
+  end
+
+  def rspec_check
+    puts "**********************************"
+    puts "RSpec Error Check"
+    puts "**********************************"
+    file = "#{@workshop_dir}/spec/workplace_spec.rb"
+    return loop_in_checks("rspec", file)
+  end
+
+  def rubocop_check
+    puts "**********************************"
+    puts "Rubocop Error Check"
+    puts "**********************************"
+    file = "#{@workshop_dir}/lib/workplace.rb"
+    return loop_in_checks("rubocop", file)
+  end
+
+  def loop_in_checks(check_mode, file)
+    count = 0
+    flag_check = false
+    flag_exit = false
+    loop do
+      count += 1
+      puts "---------------------------"
+      puts "#{check_mode} try: #{count}"
+      puts "---------------------------"
+      flag_check = system "#{check_mode} #{file}"
+      if  flag_check == true
+        puts '#{check_mode} check is clear!'
+        break
+      else
+        Common.allocate.instruct_print
+        select = STDIN.gets.chomp
+        if select == 'exit'
+          flag_exit = true
+          break
+        elsif select == 'answer'
+          system "cd #{@workshop_dir}/lib && emacs -nw -q -l #{@workshop_dir}/.emacs.d/ruby_learner_init.el sentence.org workplace.rb"
+        else
+          system "cd #{@workshop_dir}/lib && emacs -nw -q -l #{@workshop_dir}/.emacs.d/init.el  sentence.org workplace.rb"
+        end
+      end
+    end
+    return flag_check, flag_exit
+  end
+
 end