brown_noser 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 499cd85310b74f6cb80f4330be3f59fefd7c77f0
-  data.tar.gz: 0bc0ae8d96d9d849ba221430c3ad3d019369e65a
+  metadata.gz: b5d664dcc46feadfc8739def0c8d3920c4c4e093
+  data.tar.gz: 026a938363429d9accce0a82651d4c757668b32f
 SHA512:
-  metadata.gz: 9f32139d5c73a6c8aaf4f5520d78071c8d7140d998ea2dbe2adb3953ed9329f11db8c00d807297f4064a2574f9c27e9f946c47c33be818e319ad890bc7dbc99d
-  data.tar.gz: dce5f18fbccca926d2432c681f4c89916e3ce708b75f0c8641efe0585f24481045577ec1f71573a2da1e5de15bc1b2647129d80a61f71afce70fad94af83bb94
+  metadata.gz: 98e396aeca9adee12359253d4619ad56e0e9787199ed0b7524031a9df3ae4f5691e4debd9c83cf9dcbf8e66569f9bc7a10bfe9f830835a00af6ebb918b12613f
+  data.tar.gz: d3ed1ef2733619002ac66d96e375a85817461913b3c46891ece862e71d153b3166b07bf03973b96b9bb65217a2d491b9dfe82de68b45fddaac3a15ac4d3dc966

data/Gemfile

@@ -7,4 +7,5 @@ gem 'awesome_print'
 gem 'foreman'
 gem 'rake'
 gem 'pry'
+gem 'moss_ruby'
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    teachers_pet (0.1.0)
+    brown_noser (0.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -14,6 +14,7 @@ GEM
     foreman (0.78.0)
       thor (~> 0.19.1)
     method_source (0.8.2)
+    moss_ruby (1.1.2)
     multipart-post (2.0.0)
     octokit (4.2.0)
       sawyer (~> 0.6.0, >= 0.5.3)
@@ -33,12 +34,13 @@ PLATFORMS
 
 DEPENDENCIES
   awesome_print
+  brown_noser!
   bundler (~> 1.10)
   foreman
+  moss_ruby
   octokit (~> 4.0)
   pry
   rake
-  teachers_pet!
 
 BUNDLED WITH
    1.10.6

data/README.md

@@ -1,15 +1,21 @@
-# TeachersPet
+# BrownNoser
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/teachers_pet`. To experiment with that code, run `bin/console` for an interactive prompt.
+This tool is to help manage and inspect Git Repos used for our the Coursework at WCCCEDU.
 
-TODO: Delete this and the text above, and describe your gem
+## Major Milestones
+- Sync pull request branches locally so they can be reviewed and graded locally
+- Search all submissions to validate academnic honesty
+- Step through each submission branch and build/compile/execute the code
+- Run automated tests and fuzzy acceptance on output on each submission based on a project described _Rubric_ file
+- Provide DSL to work with compiled and web based execution
+- Integrate with Linters to verify student style to save time on pedantic comments by automating comments on student repos for teachers review.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'teachers_pet'
+gem 'brown_noser', '~> 0.1.2'
 ```
 
 And then execute:
@@ -18,21 +24,32 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install teachers_pet
+    $ gem install brown_noser
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem exposes the `pet` command
 
-## Development
+### Sync PR Branches
+Bring unmerged branches to local repo for easy viewing and searching without merging.
+```
+pet <user> <repo> -u <username> -p <password> -s
+pet <user> <repo> --username <username> --pasword <password> --sync
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Search for patterns in local repo (Help find cheating)
+```
+pet -f 'Your query or Regex'
+pet --find 'Your query or Regex'
+```
+
+## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Clone and run `bundle install` to receive deps.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/teachers_pet.
+Bug reports and pull requests are welcome on GitHub at https://github.com/WCCCEDU/brown_noser.
 
 
 ## License

data/lib/brown_noser/version.rb

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

data/lib/brown_noser.rb

@@ -2,6 +2,8 @@ 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'
 
 class BrownNoser
   attr_reader :options
@@ -13,8 +15,9 @@ class BrownNoser
 
       opts.on('-s', '--sync', 'Sync') { |v| @options[:sync_flag] = true }
       opts.on('-f', '--find QUERY', 'Find') { |v| @options[:query] = v }
-      opts.on('-u', '--username USER', 'Source host') { |v| @options[:username] = v }
-      opts.on('-p', '--password PASS', 'Source port') { |v| @options[:password] = v }
+      opts.on('-u', '--username USER', 'Github User') { |v| @options[:username] = v }
+      opts.on('-p', '--password PASS', 'Github Pass') { |v| @options[:password] = v }
+      opts.on('-c', '--cheat MOSSID', 'Moss Userid') { |v| @options[:moss_id] = v }
 
     end.parse!
   end
@@ -30,12 +33,16 @@ class BrownNoser
   def run
     sync = @options[:sync_flag]
     find = @options[:query]
+    cheat = @options[:moss_id]
     resolve_client
     if sync
       repo_syncer = ProjectRepoSync.new ARGV[0], ARGV[1]
       repo_syncer.sync_assignment_branches
     elsif find
       searcher = ProjectRepoSearcher.new.search find
+    elsif cheat
+      puts "CHEAT"
+      cheat_detection = CheatingDetection.new(ARGV[0], ARGV[1], cheat).detect
     end
   end
 end

data/lib/cheating_detection.rb

@@ -0,0 +1,105 @@
+require 'moss_ruby'
+require 'fileutils'
+
+class CheatingDetection
+
+  TEMP_DIR = 'brown_noser_cheat_detection'
+
+  def initialize(user, repo, moss_id = 000000000)
+    @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
+
+    # 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"
+
+    # 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")
+
+    # Get server to process files
+    url = @moss.check to_check
+
+    IO.write "brown_noser.html", "<div><h3>Cheat Detection Results</h3><br/><a href='#{url}'>#{url}</a></div>"
+    FileUtils.rm_rf TEMP_DIR
+
+    # 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|
+        report_match = <<-HTML
+          <div class="match">
+            <h3>#{file[:filename]}</h3>
+            <h4>#{file[:pct]}</h4>
+            <h4>#{file[:url]}</h4>
+            <h4>#{file[:part_url]}</h4>
+            <div class="code">#{file[:html]}</div>
+          </div>
+        HTML
+        result_html += report_match
+      }
+      result_html += "<hr/>"
+    }
+    IO.write "cheat_report.html", result_html
+  end
+end

data/lib/project_repo_sync.rb

@@ -1,8 +1,9 @@
 class ProjectRepoSync
   attr_reader :user, :repo
 
-  PULL_EXTRACTOR = ->(pull){ pull.head.label }
-  GIT_COMMAND_EXTRACTOR = ->(pull_info){ pull_info.split(':') }
+  def self.git_checkout(branch)
+    ->(){ "git checkout #{branch}" }
+  end
 
   def initialize(user, repo)
     @client = ClientResolver.client
@@ -11,8 +12,7 @@ class ProjectRepoSync
   end
 
   def sync_assignment_branches
-    pulls = @client.pulls "#{@user}/#{@repo}"
-    pull_details = pulls.map(&PULL_EXTRACTOR).map(&GIT_COMMAND_EXTRACTOR)
+    pull_details = PullBranchLister.new(@user, @repo).list
 
     %x(git checkout -f master | git branch | grep -v "^..master$" | sed 's/^[ *]*//' | sed 's/^/git branch -D /' | bash)
 
@@ -34,10 +34,6 @@ private
     ->(){ "git checkout -B #{user}/#{branch} master" }
   end
 
-  def git_checkout(branch)
-    ->(){ "git checkout #{branch}" }
-  end
-
   def git_pull(repo_url, branch)
     ->(){ "git pull #{repo_url} #{branch}" }
   end
@@ -47,7 +43,7 @@ private
       [
         git_checkout_new( pull_context[0], pull_context[1] ),
         git_pull( prep_repo(pull_context[0], @repo).call, pull_context[1] ),
-        git_checkout( 'master' )
+        ProjectRepoSync::git_checkout( 'master' )
       ]
     }
   end

data/lib/pull_branch_lister.rb

@@ -0,0 +1,16 @@
+class PullBranchLister
+
+  PULL_EXTRACTOR = ->(pull){ pull.head.label }
+  GIT_COMMAND_EXTRACTOR = ->(pull_info){ pull_info.split(':') }
+
+  def initialize(user, repo)
+    @client = ClientResolver.client
+    @user = user
+    @repo = repo
+  end
+
+  def list
+    pulls = @client.pulls "#{@user}/#{@repo}"
+    pulls.map(&PULL_EXTRACTOR).map(&GIT_COMMAND_EXTRACTOR)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brown_noser
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Scarrone
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-03 00:00:00.000000000 Z
+date: 2016-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,9 +84,11 @@ files:
 - brown_noser.gemspec
 - lib/brown_noser.rb
 - lib/brown_noser/version.rb
+- lib/cheating_detection.rb
 - lib/client_resolver.rb
 - lib/project_repo_searcher.rb
 - lib/project_repo_sync.rb
+- lib/pull_branch_lister.rb
 homepage: https://github.com/WCCCEDU/github_grading_tools_rb
 licenses:
 - MIT