ruby_learner 1.2.6 → 1.2.7

data/docs/thesis/midterm_presentation/ruby_learner_thesis/ruby_learner.md

@@ -0,0 +1,35 @@
+背景
+====
+
+小傾角粒界エネルギーはRead-Shockleyの転位模型で理論的に説明されている[\[1\]](#ReadShockley)．
+この重要な帰結として，粒界エネルギーは粒界を構成するに必要な
+幾何学的転位のバーガースベクトルの大きさに依存する．
+経験的ポテンシャル(EAM)を用いた計算（図1:青点線）では，その予測に従って，
+金属の\[100\]方位の対称傾角粒界の0度と90度の立ち上がり角に違いが見られる[\[2\]](#TschoppMcdowell)．
+しかし，測定された実験結果（図1:緑実線）にはそのような差異はなく，
+どちらも同じ角度である[\[3\]](#Otsuki)．
+これらの齟齬は数値的にはわずかであるが，転位論の信ぴょう性に関わる問題である[\[4\]](#Suzuki)．
+本研究では，どちらが正しいかを確認するため，第一原理計算をおこなった．
+
+![Alの\[100\]方位の対称傾角粒界エネルギー, EAMの計算結果(青点線),実測値(緑実線)，および第一原理計算値(赤破線)．0度，90度近辺の青直線はEAMの立ち上がり角を示す.](./all_plots.png)
+
+手法
+====
+
+第一原理計算にはVASPを用いた．計算条件は次の通りである．KPOINTは，粒界のモデルのサイズが粒界傾角によりそれぞれ違うため，VASPが用意している自動生成を用いた．Alは$d-$電子を含まないのでlength=50で行った．擬ポテンシャルにはPAWを用いた．エネルギーカットオフは300eVで計算した．緩和は原子緩和を共役勾配法による自動(IBRION
+= 2)で，外部形状は手動で緩和させて最安定のエネルギーを求めた．
+
+結果
+====
+
+図\[fig:one\]に赤破線で第一原理計算の結果を示した．
+計算結果はEAMを用いた結果に近い値を示している．
+しかし，計算に用いる系の原子サイズを大きくすると計算値は単調に減少する．
+これは，周期的境界条件にともなう転位間の相互作用や拘束の影響が考えられ，
+十分に原子緩和が完了していないことが予測される．
+発表ではEAMを用いたエネルギー解析を踏まえて， 転位論への影響を考察する．
+
+1. <a name="ReadShockley">W. T. Read Jr., and W. Shockley, “Imperfection in nearly perfect crystals”, ed. by W. Shockley, (Wiley, New York, 1952) pp.352–76. </a>
+1.  <a name="TschoppMcdowell">M. A. Tschopp and D. L. Mcdowell, Phil. Mag., <span>**87**</span>(2007), 3871. </a>
+1.  <a name="Otsuki">A. Otsuki, J. Materials Science, <span>**40**</span>(2005), 3219. </a>
+1.  <a name="Suzuki">「転位論入門」鈴木秀次, (1967 アグネ),p.77,p.350. </a>

data/docs/thesis/midterm_presentation/ruby_learner_thesis/ruby_learner.tex

@@ -0,0 +1,79 @@
+\documentclass[a4j,twocolumn]{jsarticle}
+\usepackage[dvipdfmx]{graphicx}
+\usepackage{url}
+
+\setlength{\textheight}{275mm}
+\headheight 5mm
+\topmargin -30mm
+\textwidth 185mm
+\oddsidemargin -15mm
+\evensidemargin -15mm
+\pagestyle{empty}
+
+
+\begin{document}
+
+\title{Rubygemsを用いたプログラミング言語Ruby学習の効率化}
+\author{情報科学科 \hspace{5mm} 27015464 \hspace{5mm} 大津隆輝}
+\date{}
+\maketitle
+
+\section{背景}
+西谷研究室ではプログラミング言語Rubyを使用して，言語学習や卒業研究を行なっている．
+つまり，3年生はRubyの習得が早ければ自分の研究の為の時間を確保できる．
+しかし，個人で言語学習を行う際のハードルは高いものである\cite{Oshimi}．
+その原因として，言語に対しての知識がない初心者にとって環境構築や学習の教材選びは非常に困難であることが要因の一つではないかと考えられる．環境構築なしで教材選びも必要ない言語学習サービスにはProgate\cite{Progate}やcodecademy\cite{codecademy}等があるが，環境構築という部分を排斥しているが故にそのサービス外での学習に一定の壁が生じているのではないかと考える．
+\par
+また，近年ではコードをGitで管理することで，チーム内でのコード編集の履歴をメンバーがそれぞれ確認することが出来るので，チームでの開発が管理しやすくなった\cite{GitDevelopment}．このような開発では他人の書いたコードを読み解き，それに適切な形で自分のコードを書き加える能力が必要となる．そう言った意味でも，近年の言語学習は動くだけのコードを書くのではなく言語が持つスタイルについてもきちんと学ぶ必要があると考える．
+\par
+そこで本研究では，環境構築の自動化に加え，Rubyの体系的な言語学習とプログラミングスタイルの学習ができるアプリケーションを開発し，Rubyを容易に学習できる環境を整え，実践的な学習を提供することで，個人のスキル向上の効率化を目指す．
+\section{手法}
+本研究ではGemアプリケーションruby\_learner\cite{RubyGems}を作成することで学習支援を行う．
+このアプリケーションの主な機能はemacsを用いたRubyの学習（体系的な学習・実際の開発習慣の習得）・開発環境構築の自動化である．
+上記の機能のうちRubyの学習には，テキストと課題の提供を行うことで使用者のインプット・アウトプットを通して記憶の定着を促す．
+\par
+学習の手順として，アプリ使用者にはテキストを読んでから課題に挑戦してもらう．
+課題挑戦時に使用者の回答コードが適切なものであるかを2つのチェック項目から判断する(図\ref{fig:one})．
+一つ目は，コードが期待される振る舞いをしているかである．
+期待される振る舞いの確認とは課題の意図する通りに使用者の回答コードが動作しているかの確認である．
+これはRSpecファイル\cite{rspec}と呼ばれるRuby向けのテストコードを記述するファイルを用いることで実装する．
+このチェック項目を設けることで，本研究の先駆けとなったeditor\_learner\cite{editor_learner}とは違い，使用者の独創性を尊重するコードテストを行うことができる．
+二つ目のチェック項目は，コードがRubyのプログラミングスタイルを遵守できているかの確認である．
+%Rubyのプログラミングスタイルには
+%・インデントは2スペース
+%・クラス名はキャメルでそれ以外はスネーク
+%・不要な改行がないか
+%等が挙げられる．
+これはrubyのプログラミングスタイルをチェックするGemアプリケーションRuboCop\cite{rubocop}を用いることで実装する．
+このチェック項目を設けることで，使用者は自分のコード内に存在するプログラミングスタイルから外れている部分を確認することができる．
+これら二つのチェック項目をクリアして課題の正解としている．
+
+\begin{figure}[h]
+\vspace{0\baselineskip}
+\begin{center}
+  \includegraphics[width=70mm]{./rspec_rubocop.png}
+  \caption{ruby\_learnerのrspecとrubocopを用いた２段階チェック構造.}
+  \label{fig:one}
+\end{center}
+\end{figure}
+
+環境構築の自動化は，本アプリ外でもアプリ内で行った環境でRubyの開発が行えるようにrubocop等のアプリケーションの自動インストールやemacsの設定ファイルの提供などを行う．
+
+\section{予想される結果}
+使用者は本アプリを通して，Rubyのプログラミングスタイルを遵守した上で期待される振る舞いをするコードの作成能力を習得する．また，その知識をアプリ外でも実戦で使える環境を手に入れることができる．上記の二つの効果により，使用者はアプリ外での言語学習も効率的に行えると考える．
+
+\vspace{0.5\baselineskip}
+
+{\small\setlength\baselineskip{10pt}    % 参考文献は小さめの文字で行間を詰めてある                                             
+\begin{thebibliography}{9} 
+\bibitem{Oshimi} 「Learning Style Inventoryを用いたプログラミング初学者のための教材レコメンドシステムの提案」押見太雄, (2017) p.1.
+\bibitem{Progate} Progate. \url{https://prog-8.com/mypage}.
+\bibitem{codecademy} codecademy. \url{https://www.codecademy.com/}.
+\bibitem{GitDevelopment}  Git. \url{https://git-scm.com/book/ja/v2/}.
+\bibitem{RubyGems} RubyGems. \url{https://rubygems.org}.
+\bibitem{rspec} RSpec. \url{http://rspec.info/about/}.
+\bibitem{editor_learner} editor\_learner 1.1.2, Souki Wada. \url{https://rubygems.org/gems/editor_learner/}.
+\bibitem{rubocop} RuboCop. \url{http://batsov.com/rubocop/}.
+\end{thebibliography}
+}
+\end{document}

data/docs/thesis/midterm_presentation/ruby_learner_thesis/test.md

@@ -0,0 +1,39 @@
+背景
+====
+
+小傾角粒界エネルギーはRead-Shockleyの転位模型で理論的に説明されている[@ReadShockley]．
+この重要な帰結として，粒界エネルギーは粒界を構成するに必要な
+幾何学的転位のバーガースベクトルの大きさに依存する．
+経験的ポテンシャル(EAM)を用いた計算（図1:青点線）では，その予測に従って，
+金属の\[100\]方位の対称傾角粒界の0度と90度の立ち上がり角に違いが見られる[@TschoppMcdowell]．
+しかし，測定された実験結果（図1:緑実線）にはそのような差異はなく，
+どちらも同じ角度である[@Otsuki]．
+これらの齟齬は数値的にはわずかであるが，転位論の信ぴょう性に関わる問題である[@Suzuki]．
+本研究では，どちらが正しいかを確認するため，第一原理計算をおこなった．
+
+![Alの\[100\]方位の対称傾角粒界エネルギー, EAMの計算結果(青点線),
+実測値(緑実線)，および第一原理計算値(赤破線)．0度，90度近辺の青直線はEAMの立ち上がり角を示す.<span
+data-label="fig:one"></span>](./all_plots.png){width="80mm"}
+
+手法
+====
+
+第一原理計算にはVASPを用いた．計算条件は次の通りである．KPOINTは，粒界のモデルのサイズが粒界傾角によりそれぞれ違うため，VASPが用意している自動生成を用いた．Alは$d-$電子を含まないのでlength=50で行った．擬ポテンシャルにはPAWを用いた．エネルギーカットオフは300eVで計算した．緩和は原子緩和を共役勾配法による自動(IBRION
+= 2)で，外部形状は手動で緩和させて最安定のエネルギーを求めた．
+
+結果
+====
+
+図\[fig:one\]に赤破線で第一原理計算の結果を示した．
+計算結果はEAMを用いた結果に近い値を示している．
+しかし，計算に用いる系の原子サイズを大きくすると計算値は単調に減少する．
+これは，周期的境界条件にともなう転位間の相互作用や拘束の影響が考えられ，
+十分に原子緩和が完了していないことが予測される．
+発表ではEAMを用いたエネルギー解析を踏まえて， 転位論への影響を考察する．
+
+<span>9</span> W. T. Read Jr., and W. Shockley, “Imperfection in nearly
+perfect crystals”, ed. by W. Shockley, (Wiley, New York, 1952)
+pp.352–76. M. A. Tschopp and D. L. Mcdowell, Phil. Mag.,
+<span>**87**</span>(2007), 3871. A. Otsuki, J. Materials Science,
+<span>**40**</span>(2005), 3219. 「転位論入門」鈴木秀次, (1967 アグネ),
+p.77,p.350.

data/lib/ruby_learner/common.rb

@@ -1,29 +1,6 @@
 require 'time'
 
 class Common
-  def save_restore(file: String, local_dir: String, elapsed_time: Time)
-    restore_file = ""
-    line = File.open("#{local_dir}/workshop/lib/answer.rb") do |f|
-      1.times {
-        f.gets
-      }
-      restore_file = f.gets
-    end
-    restore_file.gsub!(" ", "")
-    restore_file.delete!("#")
-    restore_file_for_csv = restore_file.match(/\d-\d/)[0]
-    Dir::chdir("#{local_dir}/restore"){
-      file_count = Dir.glob("*.rb").count
-      restore_file.insert(0, "[#{file_count}]")
-    }
-    system "touch #{local_dir}/restore/#{restore_file}"
-    system "cp #{local_dir}/workshop/lib/workplace.rb #{local_dir}/restore/#{restore_file}"
-    now_time = Time.now
-    file = File.open("#{local_dir}/practice_datas.csv", "a") do |f|
-      f.puts "#{now_time.year}/#{now_time.month}/#{now_time.day},#{now_time.hour}:#{now_time.min}:#{now_time.sec},#{elapsed_time},#{restore_file_for_csv}"
-    end
-
-  end
 
   def time_check(start_time: Time)
     end_time = Time.now
@@ -31,12 +8,6 @@ class Common
     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, local_dir: String)
     gem_contents_dir = "#{gem_dir}/contents"
     if Dir.exist?(local_dir) != true then

data/lib/ruby_learner/copspec.rb

@@ -0,0 +1,49 @@
+module CopSpec
+
+  def copspec(file_path)
+    @file = file_path
+    root = @file.match(/.*\/lib/)[0]
+    @spec = "#{root[0..root.size-5]}/spec"
+    flag_rspec = rspec_check
+    return if !flag_rspec
+    flag_rubocop = rubocop_check
+    return if !flag_rubocop
+    puts "**********************************"
+    puts "Final Error Check"
+    puts "**********************************"
+    flag_final = check("rspec", @spec)
+    if flag_final
+      puts "your code is perfect."
+    else
+      puts "not perfect, please fix your code."
+    end
+  end
+  module_function :copspec
+
+  def self.rspec_check
+    puts "**********************************"
+    puts "RSpec Error Check"
+    puts "**********************************"
+    return check("rspec", @spec)
+  end
+  private_class_method :rspec_check
+
+  def self.rubocop_check
+    puts "**********************************"
+    puts "Rubocop Error Check"
+    puts "**********************************"
+    return check("rubocop", @file)
+  end
+  private_class_method :rubocop_check
+
+  def self.check(check_mode, file)
+    flag_check = false
+    flag_check = system "#{check_mode} #{file}"
+    if  flag_check
+      puts "#{check_mode} check is clear!"
+    end
+    return flag_check
+  end
+  private_class_method :check
+
+end

data/lib/ruby_learner/pair_timer.rb

@@ -1,23 +1,13 @@
 require 'open3'
 
-class PairTimer < Thread
-  def popup_per_time_for_exe(time)
-    loop do
-      sleep time
-      system('afplay /System/Library/Sounds/Submarine.aiff')
-      o, e, s = Open3.capture3("osascript -e 'tell app \"System Events\" to display dialog \"#{time}s passed.\nPut cancel to stop pair-mode.\nPut OK to continue pair-mode.\"'")
-
-      if o != "button returned:OK\n"
-        puts 'pair timer is stopped.'
-        Thread.kill(self)
-      end
-    end
-  end
-
-  def popup_per_time_for_non_exe(time)
-    popup_file = File.expand_path("popup_per_time_for_background.rb", __FILE__)
-    p popup_file
-    system("ruby #{popup_file} #{time} &")
+time = ARGV[0].to_i
+
+loop do
+  sleep time
+  system('afplay /System/Library/Sounds/Submarine.aiff')
+  o, e, s = Open3.capture3("osascript -e 'tell app \"System Events\" to display dialog \"#{time}s passed.\nPut cancel to stop pair-mode.\nPut OK to continue pair-mode.\"'")
+  if o != "button returned:OK\n"
+    Open3.capture3("osascript -e 'tell app \"System Events\" to display dialog \"pair_popup_mode is stopped.\"'")
+    break
   end
-
 end

data/lib/ruby_learner/restore.rb

@@ -0,0 +1,81 @@
+class Restore
+  def initialize
+    @local_dir = "#{ENV['HOME']}/.ruby_learner"
+    @restore_dir = "#{@local_dir}/restore"
+  end
+
+  def save(file: String, elapsed_time: Time)
+    restore_file = ""
+    line = File.open("#{@local_dir}/workshop/lib/answer.rb") do |f|
+      1.times {
+        f.gets
+      }
+      restore_file = f.gets
+    end
+    restore_file.gsub!(" ", "")
+    restore_file.delete!("#")
+    for_csv(restore_file, elapsed_time)
+    Dir::chdir("#{@local_dir}/restore") do
+      file_count = Dir.glob("*.rb").count
+      restore_file.insert(0, "[#{file_count}]")
+    end
+    system "touch #{@local_dir}/restore/#{restore_file}"
+    system "cp #{@local_dir}/workshop/lib/workplace.rb #{@local_dir}/restore/#{restore_file}"
+  end
+
+  def output
+    sorted_restores = sort
+    if sorted_restores.size < 20
+      puts sorted_restores
+    else
+      system("ls #{@restore_dir}")
+      puts "\nlast 5 restore history."
+      puts sorted_restores[-5..-1], "\n"
+    end
+    instruct
+  end
+
+  def open(num)
+    sorted_restores = sort
+    case num
+    when 0..sorted_restores.size-1
+      filename = sorted_restores[num]
+      system("emacs #{@restore_dir}/#{filename}")
+    else
+      puts "you have #{sorted_restores.size} restore_files."
+      puts "you must put 'ruby_learner -r 0~#{sorted_restores.size - 1}.'"
+    end
+  end
+
+  private
+
+  def instruct
+    puts "If you want to open a restore_file, you execute 'ruby_learner -r [number]'"
+    puts "ex) ruby_learner -r 3"
+    print "If you want to remove all restore_files, you execute 'ruby_learner -r -f'"
+  end
+
+  def for_csv(restore_file, elapsed_time)
+    now_time = Time.now
+    restore_file.gsub!(" ", "")
+    restore_file.delete!("#")
+    sec_par = restore_file.match(/\d*-\d*/)[0]
+    file = File.open("#{@local_dir}/practice_datas.csv", "a") do |f|
+      f.puts "#{now_time.year}/#{now_time.month}/#{now_time.day},#{now_time.hour}:#{now_time.min}:#{now_time.sec},#{elapsed_time},#{sec_par}"
+    end
+  end
+
+  def sort
+    restores = []
+    dir = Dir.open(@restore_dir)
+    dir.each do |file|
+      if file != '.' && file != '..' && file != '.empty.rb'
+        restores << file.slice(1..file.length)
+      end
+    end
+    sorted_restores = restores.sort_by{|item| item.to_i}
+    sorted_restores.each{|item| item.insert(0, "[")}
+    dir.close
+    sorted_restores
+  end
+end

data/lib/ruby_learner/{typing_practice.rb → rubocop_rspec_check.rb}

@@ -1,9 +1,9 @@
 require 'fileutils'
 require 'ruby_learner/common.rb'
-require 'ruby_learner/pair_timer.rb'
+require 'ruby_learner/restore'
 require 'rubocop'
 
-class TypingPractice
+class RubocopRspecCheck
 
   def initialize(local_dir, gem_dir)
     @local_dir = local_dir
@@ -16,29 +16,21 @@ class TypingPractice
       theme_color = f.gets.chomp
     end
     @emacs_dir = "#{@datas_dir}/.emacs.d/#{theme_color}"
-    end
+  end
 
-  def prac_sequence(mode_dir: String)
+  def action(mode_dir: String, is_copy: Bool)
     start_time = Time.now
-    FileUtils.cp("#{mode_dir}/lib/workplace.rb", "#{@workshop_dir}/lib/workplace.rb")
-    FileUtils.cp("#{mode_dir}/lib/sentence.org", "#{@workshop_dir}/lib/sentence.org")
-    FileUtils.cp("#{mode_dir}/lib/answer.rb", "#{@workshop_dir}/lib/answer.rb")
-    FileUtils.cp("#{mode_dir}/spec/workplace_spec.rb", "#{@workshop_dir}/spec/workplace_spec.rb")
+    if is_copy
+      %w{lib/workplace.rb lib/sentence.org lib/answer.rb spec/workplace_spec.rb}.each do |path|
+        FileUtils.cp("#{mode_dir}/#{path}", "#{@workshop_dir}/#{path}")
+      end
+    end
     system "cd #{@workshop_dir}/lib && emacs -nw -q -l #{@emacs_dir}/init.el sentence.org workplace.rb"
-    typing_discriminant(start_time: start_time)
-  end
-
-  def typing_discriminant(start_time: Time)
-    p 'typing_discriminant'
     loop do
       flag_rspec, flag_rs_exit = rspec_check
-      if flag_rs_exit == true
-        break
-      end
+      break if flag_rs_exit == true
       flag_rubocop, flag_rub_exit = rubocop_check
-      if flag_rub_exit == true
-        break
-      end
+      break if flag_rub_exit == true
       if flag_rspec == true && flag_rubocop == true
         puts "**********************************"
         puts "Final Error Check"
@@ -56,7 +48,16 @@ class TypingPractice
     end
     elapsed_time = Common.allocate.time_check(start_time: start_time)
     p "#{elapsed_time} sec"
-    Common.allocate.save_restore(file: "#{@workshop_dir}/lib/workplace.rb", local_dir: @local_dir, elapsed_time: elapsed_time)
+    restore = Restore.new
+    restore.save(file: "#{@workshop_dir}/lib/workplace.rb", elapsed_time: elapsed_time)
+  end
+
+  private
+
+  def instruct_print
+    puts "continue >>> [RET]"
+    puts "stop >>> 'exit' + [RET]"
+    puts "check answer >>> 'answer' + [RET]"
   end
 
   def rspec_check
@@ -64,7 +65,7 @@ class TypingPractice
     puts "RSpec Error Check"
     puts "**********************************"
     file = "#{@workshop_dir}/spec/workplace_spec.rb"
-    return loop_in_checks("rspec", file)
+    return loop_per_checks("rspec", file)
   end
 
   def rubocop_check
@@ -72,10 +73,10 @@ class TypingPractice
     puts "Rubocop Error Check"
     puts "**********************************"
     file = "#{@workshop_dir}/lib/workplace.rb"
-    return loop_in_checks("rubocop", file)
+    return loop_per_checks("rubocop", file)
   end
 
-  def loop_in_checks(check_mode, file)
+  def loop_per_checks(check_mode, file)
     count = 0
     flag_check = false
     flag_exit = false
@@ -89,7 +90,7 @@ class TypingPractice
         puts "#{check_mode} check is clear!"
         break
       else
-        Common.allocate.instruct_print
+        instruct_print
         select = STDIN.gets.chomp
         if select == 'exit'
           flag_exit = true