brown_noser 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5d664dcc46feadfc8739def0c8d3920c4c4e093
-  data.tar.gz: 026a938363429d9accce0a82651d4c757668b32f
+  metadata.gz: e40fcf62cf35b124491ebfad296fef3b965c5564
+  data.tar.gz: c11e0646be3988b06ad3e84d678e59c9476e6f66
 SHA512:
-  metadata.gz: 98e396aeca9adee12359253d4619ad56e0e9787199ed0b7524031a9df3ae4f5691e4debd9c83cf9dcbf8e66569f9bc7a10bfe9f830835a00af6ebb918b12613f
-  data.tar.gz: d3ed1ef2733619002ac66d96e375a85817461913b3c46891ece862e71d153b3166b07bf03973b96b9bb65217a2d491b9dfe82de68b45fddaac3a15ac4d3dc966
+  metadata.gz: 687cc3f565935ce35417393bdc934f82e1c7efdf51a213f32548221d946a5135e98b573670cdc68ddbf1c99a966b392cbc2eb74228c673b3dddd3d2d7efe5a42
+  data.tar.gz: bb245d3eacfa69702a442f7cb2d53091ee27645e51c8f2729f782bbba68358374837b70ac45f0bfd37e8d089387482d637f1eca86421e54ad9352dd015100a51

data/README.md

@@ -43,6 +43,17 @@ pet -f 'Your query or Regex'
 pet --find 'Your query or Regex'
 ```
 
+### Detect with Cheating through MOSS
+Currently supports .cpp files only more coming soon
+```
+pet <user> <repo> -u <username> -p <password> -c <moss_id>
+```
+The resulting `brown_noser.html` will include a link so you can view the comparisons that MOSS detected as possible duplication.
+
+##### Create a moss account so you can have a moss_id
+Visit [https://theory.stanford.edu/~aiken/moss/](https://theory.stanford.edu/~aiken/moss/) and follow the instructions listed under `Registering for MOSS`.
+Once you send your registration email you will receive a response containing a bunch of perl code. Search the email for `userid`, your MOSS ID will look like this 11111927.
+
 ## Development
 
 Clone and run `bundle install` to receive deps.

data/lib/brown_noser/version.rb

@@ -1,3 +1,3 @@
 module BrownNoser
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/brown_noser.rb

@@ -1,9 +1,10 @@
 require 'optparse'
-autoload :ClientResolver, File.expand_path(File.dirname(__FILE__)) + '/client_resolver.rb'
-autoload :ProjectRepoSync, File.expand_path(File.dirname(__FILE__)) + '/project_repo_sync.rb'
-autoload :ProjectRepoSearcher, File.expand_path(File.dirname(__FILE__)) + '/project_repo_searcher.rb'
-autoload :CheatingDetection, File.expand_path(File.dirname(__FILE__)) + '/cheating_detection.rb'
-autoload :PullBranchLister, File.expand_path(File.dirname(__FILE__)) + '/pull_branch_lister.rb'
+autoload :ClientResolver,          File.expand_path(File.dirname(__FILE__)) + '/client_resolver.rb'
+autoload :ProjectRepoSync,         File.expand_path(File.dirname(__FILE__)) + '/project_repo_sync.rb'
+autoload :ProjectRepoSearcher,     File.expand_path(File.dirname(__FILE__)) + '/project_repo_searcher.rb'
+autoload :CheatingDetection,       File.expand_path(File.dirname(__FILE__)) + '/cheating_detection.rb'
+autoload :PullBranchLister,        File.expand_path(File.dirname(__FILE__)) + '/pull_branch_lister.rb'
+autoload :PullBranchFileExtractor, File.expand_path(File.dirname(__FILE__)) + '/pull_branch_file_extractor.rb'
 
 class BrownNoser
   attr_reader :options
@@ -42,7 +43,7 @@ class BrownNoser
       searcher = ProjectRepoSearcher.new.search find
     elsif cheat
       puts "CHEAT"
-      cheat_detection = CheatingDetection.new(ARGV[0], ARGV[1], cheat).detect
+      cheat_detection = CheatingDetection.new(ARGV[0], ARGV[1], {moss_id: cheat}).detect
     end
   end
 end

data/lib/cheating_detection.rb

@@ -3,87 +3,47 @@ require 'fileutils'
 
 class CheatingDetection
 
+  MOSS_LOGGER_CALLBACK = ->(message=""){puts message}
   TEMP_DIR = 'brown_noser_cheat_detection'
 
-  def initialize(user, repo, moss_id = 000000000)
+  def initialize(user, repo, moss_options={})
     @user = user
     @repo = repo
-    @moss_id = moss_id
-  end
-
-  def detect
-    pull_details = PullBranchLister.new(@user, @repo).list
-
-    recreate_tmp_dir
-
-    commands = pull_details.map &command_orgnaizer()
-
-    commands.flatten.each do |command|
-      prepared_command = command.call
-      puts prepared_command unless prepared_command.empty?
-      `#{prepared_command}` unless prepared_command.empty?
-    end
+    @moss_id = moss_options.fetch(:moss_id, 000000000)
 
     # Create the MossRuby object
     @moss ||= MossRuby.new(@moss_id) #replace 000000000 with your user id
 
     # Set options  -- the options will already have these default values
-    @moss.options[:max_matches] = 10
-    @moss.options[:directory_submission] =  false
-    @moss.options[:show_num_matches] = 250
-    @moss.options[:experimental_server] =    false
-    @moss.options[:comment] = ""
-    @moss.options[:language] = "cc"
+    @moss.options[:max_matches]          = moss_options.fetch(:max_matches,          10)
+    @moss.options[:directory_submission] = moss_options.fetch(:directory_submission, false)
+    @moss.options[:show_num_matches]     = moss_options.fetch(:show_num_matches,     250)
+    @moss.options[:experimental_server]  = moss_options.fetch(:experimental_server,  false)
+    @moss.options[:comment]              = moss_options.fetch(:comment,              '')
+    @moss.options[:language]             = moss_options.fetch(:comment,              'cc')
+  end
+
+  def detect
+    pull_details = PullBranchLister.new(@user, @repo).list
+    extractor = PullBranchFileExtractor.new(TEMP_DIR, pull_details)
+    extractor.extract
 
     # Create a file hash, with the files to be processed
     to_check = MossRuby.empty_file_hash
-    #MossRuby.add_file(to_check, "#{TEMP_DIR}/**/*.h")
-    MossRuby.add_file(to_check, "#{TEMP_DIR}/**/*.cpp")
+    files_to_check = Dir.glob("#{TEMP_DIR}/**/*").select { |f| f =~ /\.(h|cpp)$/ }
+    MossRuby.add_file(to_check, files_to_check)
 
     # Get server to process files
-    url = @moss.check to_check
+    url = @moss.check to_check, MOSS_LOGGER_CALLBACK
 
     IO.write "brown_noser.html", "<div><h3>Cheat Detection Results</h3><br/><a href='#{url}'>#{url}</a></div>"
-    FileUtils.rm_rf TEMP_DIR
+    extractor.cleanup
 
     # Get results
     results = @moss.extract_results url
   end
 
 private
-  def make_folder_for_branch(user, branch)
-    ->(){ FileUtils.mkdir_p("#{TEMP_DIR}/#{user}_#{branch}") }
-  end
-
-  def copy_file(source, dest)
-    ->(){ "cp \"#{source}\" \"#{dest}\"" }
-  end
-
-  def extract_source_files(user, branch, dest_folder)
-    ->(){
-      files = `git ls-tree --full-name --name-only -r #{user}/#{branch} | grep '.h$\\|.cpp$'`.split("\n")
-      copy_files = files.map do |file|
-        copy_file(file, "#{dest_folder}/#{file}").call
-      end
-      copy_files.join(" && ")
-    }
-  end
-
-  def recreate_tmp_dir
-    FileUtils.rm_rf TEMP_DIR
-    FileUtils.mkdir TEMP_DIR
-  end
-
-  def command_orgnaizer
-    ->(pull_context){
-      [
-        make_folder_for_branch(pull_context[0], pull_context[1]),
-        ProjectRepoSync::git_checkout("#{pull_context[0]}/#{pull_context[1]}"),
-        extract_source_files(pull_context[0], pull_context[1], "#{TEMP_DIR}/#{pull_context[0]}_#{pull_context[1]}")
-      ]
-    }
-  end
-
   def extract_results
     results.each_with_index { |match, i|
       match.each { |file|

data/lib/pull_branch_file_extractor.rb

@@ -0,0 +1,61 @@
+class PullBranchFileExtractor
+  def initialize(temp_dir, pull_details)
+    @temp_dir = temp_dir
+    @pull_details = pull_details
+  end
+
+  def extract
+    clean_tmp_dir
+    create_tmp_dir
+
+    commands = @pull_details.map &command_orgnaizer()
+
+    commands.flatten.each do |command|
+      prepared_command = command.call
+      puts prepared_command unless prepared_command.empty?
+      `#{prepared_command}` unless prepared_command.empty?
+    end
+  end
+
+  def cleanup
+    clean_tmp_dir
+  end
+
+private
+
+  def create_tmp_dir
+    FileUtils.mkdir @temp_dir
+  end
+
+  def clean_tmp_dir
+    FileUtils.rm_rf @temp_dir
+  end
+
+  def make_folder_for_branch(user, branch)
+    ->(){ FileUtils.mkdir_p("#{@temp_dir}/#{user}_#{branch}") }
+  end
+
+  def copy_file(source, dest)
+    ->(){ "cp \"#{source}\" \"#{dest}\"" }
+  end
+
+  def extract_source_files(user, branch, dest_folder)
+    ->(){
+      files = `git ls-tree --full-name --name-only -r #{user}/#{branch} | grep '\.h$\\|\.cpp$'`.split("\n")
+      copy_files = files.map do |file|
+        copy_file(file, "#{dest_folder}/#{file}").call
+      end
+      copy_files.join(" && ")
+    }
+  end
+
+  def command_orgnaizer
+    ->(pull_context){
+      [
+        make_folder_for_branch(pull_context[0], pull_context[1]),
+        ProjectRepoSync::git_checkout("#{pull_context[0]}/#{pull_context[1]}"),
+        extract_source_files(pull_context[0], pull_context[1], "#{@temp_dir}/#{pull_context[0]}_#{pull_context[1]}")
+      ]
+    }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brown_noser
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Paul Scarrone
@@ -88,6 +88,7 @@ files:
 - lib/client_resolver.rb
 - lib/project_repo_searcher.rb
 - lib/project_repo_sync.rb
+- lib/pull_branch_file_extractor.rb
 - lib/pull_branch_lister.rb
 homepage: https://github.com/WCCCEDU/github_grading_tools_rb
 licenses: