wikipedia-vandalism_detection 0.0.1

data/spec/vandalism_detection/page_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe Wikipedia::VandalismDetection::Page do
+
+  describe "constants" do
+    it "has a START_TAG constant" do
+      expect(Wikipedia::VandalismDetection::Page::START_TAG).to eq '<page>'
+    end
+
+    it "has an END_Tag constant" do
+      expect(Wikipedia::VandalismDetection::Page::END_TAG).to eq '</page>'
+    end
+  end
+
+  before do
+    @page = Wikipedia::VandalismDetection::Page.new
+  end
+
+  it "has a title" do
+    expect(@page).to respond_to :title
+  end
+
+  it "has an id" do
+    expect(@page).to respond_to :id
+  end
+
+  it "has revisions" do
+    expect(@page.revisions).to be_a Hash
+  end
+
+  it "has revisions with default {}" do
+    expect(@page.revisions).to be_empty
+  end
+
+  describe "#edits" do
+
+    it {should respond_to :edits }
+
+    it "returns an empty array if no revision is available" do
+      expect(@page.revisions).to be_empty
+      expect(@page.edits).to be_an(Array)
+      expect(@page.edits).to be_empty
+    end
+
+    it "resets the @revision_added flag to false" do
+      @page.add_revision build(:empty_revision, id: '1')
+      @page.edits
+      expect(@page.instance_variable_get(:@update_edits)).to be false
+    end
+
+    it "computes edits from the page's revisions" do
+      @page.add_revision build(:empty_revision, id: '1')
+      @page.add_revision build(:empty_revision, id: '3', parent_id: "2")
+      @page.add_revision build(:empty_revision, id: '2', parent_id: "1")
+
+      expect(@page.edits.count).to eq 2
+    end
+
+    it "computes edits of which each holds the parent page as reference" do
+      @page.id = '1234'
+      @page.title = 'Article'
+
+      @page.add_revision build(:empty_revision, id: '1')
+      @page.add_revision build(:empty_revision, id: '3', parent_id: "2")
+      @page.add_revision build(:empty_revision, id: '2', parent_id: "1")
+
+      @page.edits.each do |edit|
+        expect(edit.page).to eq @page
+      end
+    end
+  end
+
+  describe "#add_revision" do
+
+    it { should respond_to :add_revision }
+
+    it "takes a revision and adds it to revisions" do
+      revision = build :empty_revision
+      expect { @page.add_revision(revision) }.to change(@page.revisions, :count).by(1)
+    end
+
+    it "sets the @update_edits flag to true after adding a revision" do
+      revision = build :empty_revision
+      @page.add_revision(revision)
+      expect(@page.instance_variable_get(:@update_edits)).to be true
+    end
+
+    it "sets the @update_reverted_edits flag to true after adding a revision" do
+      revision = build :empty_revision
+      @page.add_revision(revision)
+      expect(@page.instance_variable_get(:@update_reverted_edits)).to be true
+    end
+  end
+
+  describe "#reverted_edits" do
+
+    it {should respond_to :reverted_edits }
+
+    it "returns reverted edits by comparing the sha1 values" do
+      # principle:
+      # in edit wars the in-between of the first revert triple which has another hash before
+      # can be seen as vandalism (here revision with id 2)
+
+      revision_1 = build(:empty_revision, id: 1, parent_id: nil,  sha1: 'hash0')
+      revision_2 = build(:empty_revision, id: 2, parent_id: 1, sha1: 'hash1')
+      revision_3 = build(:empty_revision, id: 3, parent_id: 2, sha1: 'hash2')
+      revision_4 = build(:empty_revision, id: 4, parent_id: 3, sha1: 'hash1')
+      revision_5 = build(:empty_revision, id: 5, parent_id: 4, sha1: 'hash2')
+      revision_6 = build(:empty_revision, id: 6, parent_id: 5, sha1: 'hash3')
+
+      @page.add_revision(revision_3)
+      @page.add_revision(revision_6)
+      @page.add_revision(revision_1)
+      @page.add_revision(revision_5)
+      @page.add_revision(revision_4)
+      @page.add_revision(revision_2)
+
+      expect(@page.reverted_edits.map { |edit| edit.new_revision.id }).to eq [3]
+    end
+
+    it "returns reverted edit if no previous revision is available" do
+      revision_1 = build(:empty_revision, id: 1, parent_id: nil,  sha1: 'hash1')
+      revision_2 = build(:empty_revision, id: 2, parent_id: 1, sha1: 'hash2')
+      revision_3 = build(:empty_revision, id: 3, parent_id: 2, sha1: 'hash1')
+      revision_4 = build(:empty_revision, id: 4, parent_id: 3, sha1: 'hash2')
+
+      @page.add_revision(revision_3)
+      @page.add_revision(revision_1)
+      @page.add_revision(revision_4)
+      @page.add_revision(revision_2)
+
+      expect(@page.reverted_edits.map { |edit| edit.new_revision.id }).to eq [2]
+    end
+  end
+end

data/spec/vandalism_detection/revision_parser_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Wikipedia::VandalismDetection::RevisionParser do
+
+  before do
+    @parser =  Wikipedia::VandalismDetection::RevisionParser.new
+    @xml = load_file('revision_simplified.xml')
+
+    @revision = @parser.parse @xml
+    @expected_revision = build(:empty_revision,
+                               id: 'id1',
+                               parent_id: 'parentid1',
+                               timestamp: 'time1',
+                               contributor: 'ip1',
+                               comment: 'comment 1',
+                               text: "text 1",
+                               sha1: 'hash1')
+  end
+
+  describe "#parse" do
+    it "returns a Wikipedia::Revision object" do
+      expect(@revision).to be_a Wikipedia::VandalismDetection::Revision
+    end
+
+    it "returns a revision with only the configured properties" do
+      @revision = @parser.parse(@xml, only: [:id, :parent_id])
+
+      [:id, :parent_id].each do |attr|
+        expect(@revision.send(attr)).not_to be_nil
+      end
+
+      [:timestamp, :contributor, :sha1].each do |attr|
+        expect(@revision.send(attr)).to be_nil
+      end
+
+      [:comment, :text].each do |attr|
+        expect(@revision.send(attr)).to eq ""
+      end
+    end
+  end
+
+  describe "a single revison content parsing" do
+    it "can read a single revsion dump text input" do
+      expect(@revision).to_not be_nil
+    end
+
+    [:id, :timestamp, :contributor, :comment, :text, :sha1].each do |attr|
+      it "has the expected #{attr}" do
+        expect(@revision.send(attr)).to eq @expected_revision.send(attr)
+      end
+    end
+  end
+end

data/spec/vandalism_detection/revision_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe Wikipedia::VandalismDetection::Revision do
+
+  describe "constants" do
+
+    it "has a START_TAG constant" do
+      expect(Wikipedia::VandalismDetection::Revision::START_TAG).to eq '<revision>'
+    end
+
+    it "has an END_TAG constant" do
+      expect(Wikipedia::VandalismDetection::Revision::END_TAG).to eq '</revision>'
+    end
+  end
+
+  before do
+    @revision = Wikipedia::VandalismDetection::Revision.new
+    @instance_variables = [:id, :parent_id, :timestamp, :comment, :text, :contributor_id, :contributor_ip, :sha1]
+    @nil_instance_variables = [:id, :parent_id, :timestamp, :contributor_id, :contributor_ip, :contributor_username, :sha1]
+    @read_only_attributes = [:contributor_id, :contributor_ip]
+  end
+
+  describe "#anonymous_user?" do
+    it { should respond_to :anonymous_contributor? }
+
+    it "returns true in case of an anonymous user" do
+      @anonymous_revision = build :anonymous_revision
+      expect(@anonymous_revision.anonymous_contributor?).to be true
+    end
+  end
+
+  describe "#contributor=" do
+    it { should respond_to :contributor= }
+
+    it "sets the @contributor_id if contributor is no IPv4" do
+      id = "12345"
+      @revision.contributor = id
+
+      expect(@revision.instance_variable_get(:@contributor_id)).to eq id
+      expect(@revision.instance_variable_get(:@contributor_ip)).to be_nil
+    end
+
+    it "sets the @contributor_ip if contributor is an IPv4" do
+      ip = "127.0.0.1"
+      @revision.contributor = ip
+
+      expect(@revision.instance_variable_get(:@contributor_ip)).to eq ip
+      expect(@revision.instance_variable_get(:@contributor_id)).to be_nil
+    end
+  end
+
+  describe "#contributor" do
+    it { should respond_to :contributor }
+
+    it "returns the contributor_id if set" do
+      id = "12345"
+      @revision.contributor = id
+
+      expect(@revision.contributor).to eq @revision.instance_variable_get(:@contributor_id)
+    end
+
+    it "returns the contributor_ip if set" do
+      ip = "127.0.0.1"
+      @revision.contributor = ip
+
+      expect(@revision.contributor).to eq @revision.instance_variable_get(:@contributor_ip)
+    end
+  end
+
+  it "has the revision attributes" do
+    @instance_variables.each do |name|
+      expect(@revision).to respond_to name
+    end
+  end
+
+  it "defaults its attributes to nil" do
+    @nil_instance_variables.each do |name|
+      expect(@revision.send(name)).to be_nil
+    end
+  end
+
+  it "raises an NoMethod error while accessing read only attributes" do
+    @read_only_attributes.each do |name|
+      expect { @revision.send("#{name}=", "") }.to raise_error NoMethodError
+    end
+  end
+
+  it "has an empty default text" do
+    expect(@revision.text).to be_empty
+  end
+
+  it "has a text of type Wikipedia::Text" do
+    expect(@revision.text).to be_a Wikipedia::VandalismDetection::Text
+  end
+
+  it "has an empty default comment" do
+    expect(@revision.comment).to be_empty
+  end
+
+  it "has a comment of type Wikipedia::Text" do
+    expect(@revision.comment).to be_a Wikipedia::VandalismDetection::Text
+  end
+
+  it { should respond_to :redirect? }
+
+  it "is marked as redirect if #REDIRECT appears in its text" do
+    @revision.text = "#REDIRECT [[Redirect Page Name]]\n"
+    expect(@revision.redirect?).to be true
+  end
+
+  it "is not marked as redirect if #REDIRECT does not appear in its text" do
+    @revision.text = "''text''"
+    expect(@revision.redirect?).to be false
+  end
+end

data/spec/vandalism_detection/test_dataset_spec.rb

@@ -0,0 +1,231 @@
+require 'spec_helper'
+require 'fileutils'
+require 'ruby-band'
+
+describe Wikipedia::VandalismDetection::TestDataset do
+
+  before do
+    use_test_configuration
+    @config = test_config
+
+    @arff_file = @config.test_output_arff_file
+    @index_file = @config.test_output_index_file
+    @features = @config.features
+
+    @arff_files_dir = File.join(@config.output_base_directory, 'test')
+  end
+
+  after do
+    if File.exists?(@arff_file)
+      File.delete(@arff_file)
+      FileUtils.rm_r(File.dirname @arff_file)
+    end
+
+    File.delete(@index_file) if File.exists?(@index_file)
+
+    # remove feature arff files
+    @config.features.each do |name|
+      file = File.join(@arff_files_dir, name.gsub(' ', '_') + '.arff')
+
+      if File.exists?(file)
+        File.delete(file)
+        FileUtils.rm_r(File.dirname file)
+      end
+    end
+  end
+
+  describe "#build" do
+    describe "exceptions" do
+      it "raises an EditsFileNotConfiguredError if no edits file is configured" do
+        config = test_config
+        config.instance_variable_set :@test_corpus_edits_file, nil
+        use_configuration(config)
+
+        expect { Wikipedia::VandalismDetection::TestDataset.build }.to raise_error \
+          Wikipedia::VandalismDetection::EditsFileNotConfiguredError
+      end
+    end
+
+    it "returns a weka instances" do
+      dataset = Wikipedia::VandalismDetection::TestDataset.build
+      expect(dataset.class).to be Java::WekaCore::Instances
+    end
+
+    Wikipedia::VandalismDetection::DefaultConfiguration::DEFAULTS['features'].each do |name|
+      it "creates an arff file for the feature '#{name}'" do
+        config = test_config
+        config.instance_variable_set :@features, [name]
+        use_configuration(config)
+
+        file = File.join(@arff_files_dir, name.gsub(' ', '_') + '.arff')
+
+        expect(File.exist?(file)).to be false
+        Wikipedia::VandalismDetection::TestDataset.build
+        expect(File.exist?(file)).to be true
+      end
+    end
+
+    it "creates only feature files that are not available yet" do
+      config = test_config
+      config.instance_variable_set :@features, ['anonymity', 'comment length']
+      use_configuration(config)
+
+      anonymity_file = File.join(config.output_base_directory, 'test', 'anonymity.arff')
+
+      # create file manually, so it is existent when building dataset
+      data = [10000, 123456, 234567]
+      anonymity = Wikipedia::VandalismDetection::Instances.empty_for_test_feature('anonymity')
+      6.times { anonymity.add_instance(data) }
+      anonymity.to_ARFF(anonymity_file)
+
+      Wikipedia::VandalismDetection::TestDataset.build
+
+      # anonymity should not be overwritten
+      expect(Core::Parser.parse_ARFF(anonymity_file).to_a2d.first).to eq data
+    end
+
+    describe "internal algorithm" do
+      it "builds the right number of data lines" do
+        edits_count = File.open(@config.training_corpus_edits_file, 'r').lines.count - 1
+        additional_header_lines = 4 # without class
+        revision_id_lines = 2 # old and new revision id attributes
+        class_line = 1
+
+        lines_count = additional_header_lines + edits_count + @features.count + revision_id_lines + class_line
+        dataset = Wikipedia::VandalismDetection::TestDataset.build
+
+        expect(dataset.to_s.lines.count).to eq lines_count
+      end
+
+      it "builds the right number of data columns" do
+        old_and_new_edit_attr_count = 2
+        class_value = 1
+        dataset = Wikipedia::VandalismDetection::TestDataset.build
+
+        expect(dataset.n_col).to eq @features.count + class_value + old_and_new_edit_attr_count
+      end
+
+      it "builds a class attribute" do
+        dataset = Wikipedia::VandalismDetection::TestDataset.build
+        expect(dataset.enumerate_attributes.to_a[-1].name).to eq 'class'
+      end
+    end
+
+    it "normalizes the numeric features if LibSVM is used as classifier" do
+      config = test_config
+      config.instance_variable_set :@classifier_type, 'Functions::LibSVM'
+      use_configuration(config)
+
+      dataset = Wikipedia::VandalismDetection::TestDataset.build
+      puts dataset
+
+      dataset.to_a2d.each do |instance|
+        puts instance.to_s
+        numerics = instance[0...-3] # feature values
+        edit_ids = instance[-3..-2] # revision ids
+
+        numerics.each { |value| expect(value).to be_between(0.0, 1.0) }
+        edit_ids.each { |value| expect(value).to be > 1 }
+      end
+    end
+  end
+
+  describe "#instances" do
+    it "is an alias method for #build" do
+      build = Wikipedia::VandalismDetection::TestDataset.build
+      instances = Wikipedia::VandalismDetection::TestDataset.instances
+
+      expect(build.to_s).to eq instances.to_s
+    end
+  end
+
+  describe "#create_corpus_index_file!" do
+    it "responds to #create_corpus_file_index!" do
+      expect(Wikipedia::VandalismDetection::TestDataset).to respond_to :create_corpus_file_index!
+    end
+
+    describe "exceptions" do
+      it "raises an RevisionsDirectoryNotConfiguredError if no revisions directory is configured" do
+        config = test_config
+        config.instance_variable_set :@test_corpus_revisions_directory, nil
+        use_configuration(config)
+
+        expect { Wikipedia::VandalismDetection::TestDataset.create_corpus_file_index! }.to raise_error \
+          Wikipedia::VandalismDetection::RevisionsDirectoryNotConfiguredError
+      end
+    end
+
+    it "creates a corpus_index.yml file in the build directory" do
+      expect(File.exist?(@index_file)).to be false
+      Wikipedia::VandalismDetection::TestDataset.create_corpus_file_index!
+      expect(File.exist?(@index_file)).to be true
+    end
+  end
+
+  describe "#build!" do
+    it "should respond to #build!" do
+      expect(Wikipedia::VandalismDetection::TestDataset).to respond_to :build!
+    end
+
+    it "creates an .arff file in the directory defined in config.yml" do
+      expect(File.exist?(@arff_file)).to be false
+      Wikipedia::VandalismDetection::TestDataset.build!
+      expect(File.exist?(@arff_file)).to be true
+    end
+
+    it "overwrites existing test arff file" do
+      use_test_configuration
+
+      # test config uses 3 features + 2 edit id columns + 1 class value = 6
+      Wikipedia::VandalismDetection::TestDataset.build!
+      first_parsed_dataset = Core::Parser.parse_ARFF(@arff_file)
+      expect(first_parsed_dataset.n_col).to eq 6
+
+      config = test_config
+      config.instance_variable_set(:@features, ['anonymity'])
+      use_configuration(config)
+
+      # uses only 1 feature + 2 edit id columns + 1 class vlaue = 4
+      Wikipedia::VandalismDetection::TestDataset.build!
+      second_parsed_dataset = Core::Parser.parse_ARFF(@arff_file)
+
+      expect(second_parsed_dataset.n_col).to eq 4
+    end
+  end
+
+  describe "#edit" do
+    it "raises an EditsFileNotConfiguredError if no edits file is configured" do
+      config = test_config
+      config.instance_variable_set :@test_corpus_edits_file, nil
+      use_configuration(config)
+
+      expect { Wikipedia::VandalismDetection::TestDataset.edit('1', '2') }.to raise_error \
+          Wikipedia::VandalismDetection::EditsFileNotConfiguredError
+    end
+
+    it "returns nil if Edit could not be found" do
+      edit = Wikipedia::VandalismDetection::TestDataset.edit('1', '2')
+      expect(edit).to be_nil
+    end
+
+    it "returns an Edit" do
+      edit = Wikipedia::VandalismDetection::TestDataset.edit('307084144', '326873205')
+      expect(edit).to be_a Wikipedia::VandalismDetection::Edit
+    end
+
+    it "returns an edit whose parent page title is not nil" do
+      edit = Wikipedia::VandalismDetection::TestDataset.edit('307084144', '326873205')
+      expect(edit.page.title).to_not be_nil
+    end
+
+    it "returns an edit whose parent page id is not nil" do
+      edit = Wikipedia::VandalismDetection::TestDataset.edit('307084144', '326873205')
+      expect(edit.page.id).to_not be_nil
+    end
+
+    it "returns nil for a not annotated edit with given revision ids" do
+      edit = Wikipedia::VandalismDetection::TestDataset.edit('328774088', '328774188')
+      expect(edit).to be_nil
+    end
+  end
+end