llt-review 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c67647d0b4ba29bff3feb4066ed2d11eb2253a41
+  data.tar.gz: 6f8ba9c45e85319859765ce378ead8a654a2f12a
+SHA512:
+  metadata.gz: 6bf66bd60ab8558ea51be1fa765c87540cbd419e993cdfe1ec4ce188284c19685c739f05f88115d4cb6b93bddcbdca91a71c19be378fa91c66653dbb6bc3427b
+  data.tar.gz: 9bba65d16cc077da638427d74aa31d84e258aa14f2456757903ea801cfd08e7b91999bfeee6526f503831d7c17e39342b65f2cf1c5bd8f9feac7389f4ed8082b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+language: ruby
+before_script:
+- export JRUBY_OPTS=--2.0
+rvm:
+- 2.1.0
+- 2.0.0
+- jruby-1.7.10

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in llt-diff.gemspec
+gemspec
+gem 'coveralls', require: false
+
+gem 'llt-core', git: 'git://github.com/latin-language-toolkit/llt-core.git'
+
+gem 'ox', platform: :ruby
+
+platform :jruby do
+  gem 'nokogiri'
+  gem 'jruby-httpclient'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 LFDM
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# LLT::Review
+
+[![Version](http://allthebadges.io/latin-language-toolkit/llt-review/badge_fury.png)](http://allthebadges.io/latin-language-toolkit/llt-review/badge_fury)
+[![Dependencies](http://allthebadges.io/latin-language-toolkit/llt-review/gemnasium.png)](http://allthebadges.io/latin-language-toolkit/llt-review/gemnasium)
+[![Build Status](http://allthebadges.io/latin-language-toolkit/llt-review/travis.png)](http://allthebadges.io/latin-language-toolkit/llt-review/travis)
+[![Coverage](http://allthebadges.io/latin-language-toolkit/llt-review/coveralls.png)](http://allthebadges.io/latin-language-toolkit/llt-review/coveralls)
+[![Code Climate](http://allthebadges.io/latin-language-toolkit/llt-review/code_climate.png)](http://allthebadges.io/latin-language-toolkit/llt-review/code_climate)
+
+Compares annotations
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'llt-review'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install llt-review
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/llt-review/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/config.ru

@@ -0,0 +1,2 @@
+require 'llt/review/api'
+run Api

data/lib/llt/review/alignment/comparison.rb

@@ -0,0 +1,6 @@
+module LLT
+  class Review::Alignment
+    class Comparison < Review::Common::Comparison
+    end
+  end
+end

data/lib/llt/review/alignment/data.rb

@@ -0,0 +1,7 @@
+module LLT
+  class Review::Alignment
+    class Data
+      include Core::Structures::HashContainable
+    end
+  end
+end

data/lib/llt/review/alignment/difference/nrefs.rb

@@ -0,0 +1,29 @@
+module LLT
+  module Review::Alignment::Difference
+
+    # This whole class could arguably deleted, not sure there is any need for it
+
+    class Nrefs
+      include Core::Structures::HashContainable
+      include Review::Helpers::ReviewReporter
+
+      xml_tag :nrefs
+
+      def initialize(original, new)
+        @id = id
+        @original = original
+        @new = new
+        @container = {}
+      end
+
+      def id
+        xml_tag
+      end
+
+      def xml_attributes
+        { original: @original, new: @new, unique: @unique }
+      end
+    end
+  end
+end
+

data/lib/llt/review/alignment/difference/sentence.rb

@@ -0,0 +1,6 @@
+module LLT
+  module Review::Alignment::Difference
+    class Sentence < Review::Common::Difference::Sentence
+    end
+  end
+end

data/lib/llt/review/alignment/difference/translation.rb

@@ -0,0 +1,27 @@
+module LLT
+  module Review::Alignment::Difference
+    class Translation
+      include Core::Structures::HashContainable
+      include Review::Helpers::ReviewReporter
+
+      xml_tag :translation
+
+      attr_reader :original, :new
+
+      def initialize(original, new)
+        @id = id
+        @original = original
+        @new = new
+        @container = {}
+      end
+
+      def id
+        xml_tag
+      end
+
+      def xml_attributes
+        { original: @original, new: @new, unique: @unique }
+      end
+    end
+  end
+end

data/lib/llt/review/alignment/difference/word.rb

@@ -0,0 +1,27 @@
+module LLT
+  module Review::Alignment::Difference
+    class Word < Review::Common::Difference::Word
+      def diff_id
+        @diff_id ||= "#{@id}:#{original}|#{new}"
+      end
+
+      # go right to the translation - we have the nrefs too, not sure
+      # if we need them actually
+      def original
+        @original ||= @container[:translation].original
+      end
+
+      def new
+        @new ||= @container[:translation].new
+      end
+
+      private
+
+      def write_to_report(report, unique)
+        super
+        container = report[:words]
+        container[item.to_s].add_wrong(unique)
+      end
+    end
+  end
+end

data/lib/llt/review/alignment/difference.rb

@@ -0,0 +1,11 @@
+module LLT
+  class Review::Alignment
+    module Difference
+      require 'llt/review/alignment/difference/sentence'
+      require 'llt/review/alignment/difference/word'
+      require 'llt/review/alignment/difference/translation'
+      require 'llt/review/alignment/difference/nrefs'
+    end
+  end
+end
+

data/lib/llt/review/alignment/gold.rb

@@ -0,0 +1,9 @@
+module LLT
+  class Review::Alignment
+    class Gold < Report
+      include Review::Common::Golden
+    end
+  end
+end
+
+

data/lib/llt/review/alignment/parser/helper.rb

@@ -0,0 +1,43 @@
+module LLT
+  class Review::Alignment::Parser
+    module Helper
+      def namespace
+        Review::Alignment
+      end
+
+      private
+
+      def register_sentence(value)
+        super
+        @sentence.lang1 = @lang1
+        @sentence.lang2 = @lang2
+      end
+
+      def register_word(value)
+        value = stripped_id(value)
+        return super if @original
+        @translation = namespace.const_get(:Translation).new(value.to_i)
+      end
+
+      def register_translation(refs)
+        refs.split.map { |ref| stripped_id(ref).to_i }.each do |ref|
+          @sentence[ref].add(@translation)
+        end
+      end
+
+      def stripped_id(value)
+        value.slice(/(?<=-).*/)
+      end
+
+      def set_orig_or_translation(value)
+        @original = value == "L1"
+      end
+
+      def set_text(value)
+        return unless @in_text
+        target = @original ? @word : @translation
+        target.text = value
+      end
+    end
+  end
+end

data/lib/llt/review/alignment/parser/nokogiri_handler.rb

@@ -0,0 +1,44 @@
+require 'nokogiri'
+
+module LLT
+  class Review::Alignment::Parser
+    class NokogiriHandler < Nokogiri::XML::SAX::Document
+
+      include Review::Helpers::Parsing::Helper
+      include Review::Helpers::Parsing::Helper::ForNokogiri
+      include Helper
+
+      def parse(data)
+        Nokogiri::XML::SAX::Parser.new(self).parse(data)
+      end
+
+      def start_element(name, attrs = [])
+        case name
+        when 'w'        then register_word(first_val(attrs))
+        when 'text'     then @in_text = true
+        when 'refs'     then register_translation(first_val(attrs)) unless @original
+        when 'wds'      then set_orig_or_translation(Hash[attrs]['lnum'])
+        when 'sentence' then register_sentence(Hash[attrs]['id'])
+        when 'language' then set_languages(attrs)
+        end
+      end
+
+      def end_element(name)
+        @in_text = false if name == 'text'
+      end
+
+      def characters(string)
+        set_text(string)
+      end
+
+      private
+
+      def set_languages(attrs)
+        hsh = Hash[attrs]
+        lang = hsh['xml:lang']
+        hsh['lnum'] == 'l1' ? @lang1 = lang : @lang2 = lang
+      end
+    end
+  end
+end
+

data/lib/llt/review/alignment/parser/ox_handler.rb

@@ -0,0 +1,68 @@
+require 'ox'
+
+module LLT
+  class Review::Alignment::Parser
+    class OxHandler < Ox::Sax
+
+      include Review::Helpers::Parsing::Helper
+      include Helper
+
+      def parse(data)
+        Ox.sax_parse(self, data)
+      end
+
+      def start_element(name)
+        if @in_word
+          case name
+          when :text     then @in_text = true
+          when :refs     then @in_refs = true
+          end
+        else
+          case name
+          when :w        then @in_word     = true
+          when :wds      then @in_wds      = true
+          when :sentence then @in_sentence = true
+          when :language then @in_language = true
+          end
+        end
+      end
+
+      def end_element(name)
+        case name
+        when :w        then @in_word = false
+        when :text     then @in_text = false
+        when :refs     then @in_refs = false
+        when :wds      then @in_wds  = false
+        when :sentence then @in_sentence = false
+        when :language then @in_language = false
+        end
+      end
+
+      def attr(name, value)
+        if @in_word
+          case name
+          when :n     then register_word(value)
+          when :nrefs then register_translation(value) unless @original
+          end
+        else
+          case
+          when @in_wds      then set_orig_or_translation(value) if name == :lnum
+          when @in_sentence then register_sentence(value) if name == :id
+          when @in_language then set_languages(name, value)
+          end
+        end
+      end
+
+      def text(value)
+        set_text(value)
+      end
+
+      private
+
+      def set_languages(name, value)
+        return unless name == :"xml:lang"
+        @lang1 ? @lang2 = value : @lang1 = value
+      end
+    end
+  end
+end

data/lib/llt/review/alignment/parser.rb

@@ -0,0 +1,13 @@
+module LLT
+  class Review::Alignment
+    class Parser
+      require 'llt/review/alignment/parser/helper'
+
+      autoload :NokogiriHandler, 'llt/review/alignment/parser/nokogiri_handler'
+      autoload :OxHandler,       'llt/review/alignment/parser/ox_handler'
+
+      include Review::Helpers::Parsing
+    end
+  end
+end
+

data/lib/llt/review/alignment/report/generic.rb

@@ -0,0 +1,10 @@
+module LLT
+  class Review::Alignment::Report
+    class Generic < Review::Common::Report::Generic
+      def collect_reports(words)
+        return unless @reports_to_request
+        words.each { |_, word| add(word.report) }
+      end
+    end
+  end
+end

data/lib/llt/review/alignment/report/translation.rb

@@ -0,0 +1,7 @@
+module LLT
+  class Review::Alignment::Report
+    class Translation
+      include Review::Helpers::Reportable
+    end
+  end
+end

data/lib/llt/review/alignment/report/word.rb

@@ -0,0 +1,7 @@
+module LLT
+  class Review::Alignment::Report
+    class Word
+      include Review::Helpers::Reportable
+    end
+  end
+end

data/lib/llt/review/alignment/report.rb

@@ -0,0 +1,15 @@
+module LLT
+  class Review::Alignment
+    class Report < Review::Common::Report
+      require 'llt/review/alignment/report/generic'
+      require 'llt/review/alignment/report/word'
+      require 'llt/review/alignment/report/translation'
+
+      private
+
+      def namespace
+        Report
+      end
+    end
+  end
+end

data/lib/llt/review/alignment/reviewable.rb

@@ -0,0 +1,6 @@
+module LLT
+  class Review::Alignment
+    class Reviewable < Review::Common::Reviewable
+    end
+  end
+end

data/lib/llt/review/alignment/sentence.rb

@@ -0,0 +1,18 @@
+module LLT
+  class Review::Alignment
+    class Sentence < Review::Common::Sentence
+
+      attr_accessor :lang1, :lang2
+
+      private
+
+      def report_container
+        { words: Report::Generic.new(:words, size, true) }
+      end
+
+      def diff_namespace
+        Review::Alignment::Difference
+      end
+    end
+  end
+end

data/lib/llt/review/alignment/translation.rb

@@ -0,0 +1,13 @@
+module LLT
+  class Review::Alignment
+    class Translation
+      include Core::Structures::HashContainable
+
+      attr_accessor :text
+
+      def to_s
+        @text
+      end
+    end
+  end
+end

data/lib/llt/review/alignment/word.rb

@@ -0,0 +1,38 @@
+module LLT
+  class Review::Alignment
+    class Word
+      include Core::Structures::HashContainable
+
+      attr_accessor :text
+
+      def to_s
+        @text
+      end
+
+      def translation
+        @translation ||= @container.values.map(&:to_s).join(' ')
+      end
+
+      def nrefs
+        @container.keys.map(&:to_s).join(' ')
+      end
+
+      # star is for additional params other classes like Treebank need
+      def compare(other, diff_container, *)
+        unless translation == other.translation
+          d = diff_container[id] ||= Difference::Word.new(self)
+          d.add(Difference::Translation.new(translation, other.translation))
+          d.add(Difference::Nrefs.new(nrefs, other.nrefs))
+        end
+      end
+
+      def report
+        @report ||= begin
+          rep = Report::Word.new(@text)
+          rep.add(Report::Translation.new(translation))
+          rep
+        end
+      end
+    end
+  end
+end

data/lib/llt/review/alignment.rb

@@ -0,0 +1,23 @@
+module LLT
+  class Review::Alignment < Review
+    require 'llt/review/alignment/parser'
+
+    require 'llt/review/alignment/report'
+    require 'llt/review/alignment/gold'
+    require 'llt/review/alignment/reviewable'
+    require 'llt/review/alignment/comparison'
+
+    require 'llt/review/alignment/sentence'
+    require 'llt/review/alignment/word'
+    require 'llt/review/alignment/translation'
+
+    require 'llt/review/alignment/difference'
+
+    private
+
+    def root_identifier
+      'alignment'
+    end
+  end
+end
+

data/lib/llt/review/api.rb

@@ -0,0 +1,37 @@
+require 'sinatra/base'
+require 'sinatra/respond_with'
+require 'llt/review'
+
+class Api < Sinatra::Base
+  register Sinatra::RespondWith
+
+  get '/:type/diff' do
+    gold = Array(params[:gold])
+    rev  = Array(params[:reviewable])
+
+    comp_param = params[:compare]
+    comparables = comp_param ? Array(comp_param).map(&:to_sym) : nil
+
+    klass = params[:type]
+    # return an error if klass is neither treebank nor Alignment
+
+    diff = LLT::Review.const_get(klass.capitalize).new
+    puts comparables
+    diff.diff(gold, rev, comparables)
+
+    respond_to do |f|
+      f.xml { diff.to_xml }
+    end
+  end
+
+  get '/:type/report' do
+    uris = Array(params[:uri])
+    klass = params[:type]
+    reporter = LLT::Review.const_get(klass.capitalize).new
+    reporter.report(*uris)
+
+    respond_to do |f|
+      f.xml { reporter.to_xml(:report)}
+    end
+  end
+end