rankum 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bfcd33262f5033679e1a112d87cebdbae692f61
+  data.tar.gz: 07bf96be3547b2b68667e2370dca1a59021b5ba9
+SHA512:
+  metadata.gz: 92f1d306c828df791b98e774c52c3cc39d2177039e059ad315fd62415a3275f2c5196f016392c153c3fd74da002c508ae07281908a19c2c6b579b8d5fa20959b
+  data.tar.gz: 90c2b8a7ed0c28b0aff6c992018892ff51ccffd87474c435c6e46556fc998daae0a5e5a7c054d55cb5bb6b12f1cf13f25668614d7de74a8ce134c983c1e3840d

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--order random
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+ruby "2.2.3"
+
+gem "rspec"
+gem "byebug"
+
+gem "mixlib-cli", "~> 1.5.0"
+gem "paint", "~> 1.0.1"

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (8.2.2)
+    diff-lcs (1.2.5)
+    mixlib-cli (1.5.0)
+    paint (1.0.1)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  mixlib-cli (~> 1.5.0)
+  paint (~> 1.0.1)
+  rspec
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,34 @@
+# Rankum
+A tool to compare search ranks using flexible quality rank metrics.
+It helps to evaluate how good your search results are ranked when compared to a perfect (ideal) rank.
+
+## Rank Metrics
+To help you out, Rankum extract some metrics to "measure" search rank relevancy.
+
+##### FCP (Fraction Concordant pairs)
+Basically, this metric counts how many pairs occuring on perfect rank are also on actual search rank.
+Supposing search results are A, B, C, D and E items. For this pefect rank, we have 10 pair combinations (AB, AC, AD, AE, BC, BD, BE, CD, CE, DE).
+**FCP measures the fraction (percentage) of these pairs on actual ranks.**
+
+## Install
+
+```ruby
+gem install rankum
+```
+
+## Usage
+
+##### Command-line mode
+
+Options:
+```shell
+-m, --metric metric                             Metric used to compare search ranks
+-a, --actual_rank actual_rank_file_path         Actual Rank file (only for RankFileReader strategy)
+-p, --perfect_rank perfect_rank_file_path       Perfect Rank file (only for RankFileReader strategy)
+-r, --rank_reader rank_reader                   Strategy to to read your ranks
+```
+
+```shell
+$ rankum -m FCP -r RankFileReader -p perfect_rank.txt -a my_rank.txt
+```
+![Rankum output](http://thecodeknight.herokuapp.com/img/rankum_output.png)

data/bin/rankum

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'rankum'
+
+cli = Rankum::CLI.new
+cli.parse_options
+
+result = Rankum::Runners::RankumCLI.run(cli.config)
+result.output.each do |line|
+  puts line
+end

data/lib/rankum/metrics/fcp_calculator.rb

@@ -0,0 +1,58 @@
+require_relative "../utils/fcp_pair"
+require_relative "../utils/interactor"
+
+module Rankum
+  module Metrics
+    class FCPCalculator
+      include Rankum::Utils::Interactor
+
+      def self.run context
+        FCPCalculator.new(context).run
+      end
+
+      def run
+        execute { context.value = calculate_fcp }
+      end
+
+      private
+      def perfect_rank_pairs
+        @perfect_rank_pairs ||= Rankum::Utils::FCPPair.to_h(perfect_rank)
+      end
+
+      def actual_rank_pairs
+        @actual_rank_pairs ||= Rankum::Utils::FCPPair.to_a(actual_rank)
+      end
+
+      def calculate_fcp
+        total_pairs = perfect_rank_pair_count
+
+        actual_rank_pairs.each do |pair|
+          if perfect_rank_pairs[pair] > 0
+            perfect_rank_pairs[pair] -= 1
+          end
+        end
+
+        not_matched_pairs = perfect_rank_pair_count
+        result = (total_pairs - not_matched_pairs).to_f / total_pairs
+        result > 0 ? result : 0
+      end
+
+      def perfect_rank_pair_count
+        perfect_rank_pairs.reduce(0) { |acc, (k,v)| acc += v }
+      end
+
+      def rank_reader
+        @reader ||= context.rank_reader
+      end
+
+      def perfect_rank
+        @perfect_rank ||= rank_reader.perfect_rank
+      end
+
+      def actual_rank
+        @actual_rank ||= rank_reader.actual_rank
+      end
+
+    end
+  end
+end

data/lib/rankum/readers/rank_file_reader.rb

@@ -0,0 +1,35 @@
+module Rankum
+  module Readers
+    class RankFileReader
+
+      def initialize
+        @perfect_rank = []
+        @actual_rank = []
+      end
+
+      def add_perfect_rank_path path
+        @perfect_rank = [] unless @perfect_rank.empty?
+        @perfect_rank = to_array(path)
+      end
+
+      def add_actual_rank_path path
+        @actual_rank = [] unless @actual_rank.empty?
+        @actual_rank = to_array(path)
+      end
+
+      def perfect_rank
+        @perfect_rank
+      end
+
+      def actual_rank
+        @actual_rank
+      end
+
+      private
+      def to_array rank_path
+         IO.readlines(rank_path).map { |item| item.strip}
+      end
+
+    end
+  end
+end

data/lib/rankum/runners/cli_outputer.rb

@@ -0,0 +1,43 @@
+require_relative "../utils/interactor"
+require 'paint'
+
+module Rankum
+  module Runners
+    class CLIOutputer
+      include Rankum::Utils::Interactor
+
+      def self.run context={}
+        CLIOutputer.new(context).run
+      end
+
+      def run
+        execute do
+          fail! unless raw_value
+          context.value = round(raw_value)
+          context.output = output
+        end
+      end
+
+      private
+      def raw_value
+        @raw_value ||= context.value
+      end
+
+      def round value
+        (value * 100).round(2)
+      end
+
+      def output
+        lines = []
+        lines << "Rankum"
+        lines << "------------"
+        lines << "Metric: #{context.metric}"
+
+        color = raw_value > 0.7 ? :green : :red
+        lines << "Similarity: #{Paint["#{context.value} %", color, :bright]}"
+        lines
+      end
+
+    end
+  end
+end

data/lib/rankum/runners/cli_setup.rb

@@ -0,0 +1,29 @@
+require_relative "../metrics/fcp_calculator"
+require_relative "../readers/rank_file_reader"
+require_relative "../utils/interactor"
+
+module Rankum
+  module Runners
+    class CLISetup
+      include Rankum::Utils::Interactor
+
+      def self.run context
+        CLISetup.new(context).run
+      end
+
+      def run
+        execute { context.rank_reader = rank_reader }
+      end
+
+      private
+      def rank_reader
+        reader = Object::const_get("::Rankum::Readers::#{context.rank_reader}").new
+
+        reader.add_perfect_rank_path(context.perfect_rank)
+        reader.add_actual_rank_path(context.actual_rank)
+
+        reader
+      end
+    end
+  end
+end

data/lib/rankum/runners/rankum_cli.rb

@@ -0,0 +1,23 @@
+require "interactor"
+require_relative "../metrics/fcp_calculator"
+require_relative "cli_setup"
+require_relative "cli_outputer"
+
+module Rankum
+  module Runners
+    class RankumCLI
+      include Rankum::Utils::Interactor
+
+      def self.run context
+        RankumCLI.new(context).run
+      end
+
+      def run
+        organize Rankum::Runners::CLISetup,
+                 Rankum::Metrics::FCPCalculator,
+                 Rankum::Runners::CLIOutputer
+      end
+
+    end
+  end
+end

data/lib/rankum/utils/fcp_pair.rb

@@ -0,0 +1,23 @@
+module Rankum
+  module Utils
+    module FCPPair
+
+      class Rankum::Utils::Pair < Struct.new(:actual, :next); end
+
+      def self.to_a(rank)
+        rank.each_with_index.inject([]) do |pairs, (item, idx)|
+          rank[(idx + 1)..-1].each { |next_item| pairs << Pair.new(item, next_item) }
+          pairs
+        end
+      end
+
+      def self.to_h(rank)
+        to_a(rank).inject(Hash.new(0)) do |pairs, item|
+          pairs[item] += 1
+          pairs
+        end
+      end
+
+    end
+  end
+end

data/lib/rankum/utils/interactor.rb

@@ -0,0 +1,50 @@
+require "ostruct"
+
+module Rankum
+  module Utils
+    module Interactor
+
+      def initialize context={}
+        @context = OpenStruct.new(context)
+      end
+
+      def execute
+        begin
+          yield
+          exit if @context.fail?
+          success!
+         rescue Exception => e
+           fail!
+        end
+
+        @context
+      end
+
+      def organize *interactors
+        interactors.each do |interactor|
+          context_hash = @context.to_h
+          context = interactor.run(context_hash)
+
+          @context = OpenStruct.new(context_hash.merge!(context.to_h))
+        end
+
+        @context
+      end
+
+      def context
+        @context
+      end
+
+      def fail!
+        @context.send("success?=",false)
+        @context.send("fail?=",true)
+      end
+
+      def success!
+        @context.send("success?=",true)
+        @context.send("fail?=",false)
+      end
+
+    end
+  end
+end

data/lib/rankum.rb

@@ -0,0 +1,30 @@
+require "mixlib/cli"
+require_relative "rankum/runners/rankum_cli"
+
+module Rankum
+  class CLI
+    include Mixlib::CLI
+
+    option :metric,
+      :short => "-m metric",
+      :long  => "--metric metric",
+      :default => "fcp",
+      :description => "Metric used to compare search ranks"
+
+    option :rank_reader,
+      :short => "-r rank_reader",
+      :long  => "--rank_reader rank_reader",
+      :default => "RankFileReader",
+      :description => "Strategy to to read your ranks"
+
+    option :perfect_rank,
+      :short => "-p perfect_rank_file_path",
+      :long  => "--perfect_rank perfect_rank_file_path",
+      :description => "Perfect Rank file (only valid for RankFileReader strategy)"
+
+    option :actual_rank,
+      :short => "-a actual rank_file_path",
+      :long  => "--actual_rank actual_rank_file_path",
+      :description => "Actual Rank file (only valid for RankFileReader strategy)"
+  end
+ end

data/rankum.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name        = "rankum"
+  spec.version     = "1.0.0"
+
+  spec.author      = "Felipe Besson"
+  spec.email       = "flpbesson@gmail.com"
+  spec.date        = "2016-05-06"
+  spec.summary     = "Measure search rank quality"
+  spec.description = "A gem to compare search ranks using flexible quality rank metrics"
+  spec.homepage    = "https://github.com/besson/rankum"
+  spec.license     = "MIT"
+
+  spec.files       = `git ls-files`.split("\n")
+  spec.test_files  = spec.files.grep(/^spec/)
+  spec.executables = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+
+  spec.add_dependency("mixlib-cli", "~> 1.5")
+  spec.add_dependency("paint", "~> 1.0")
+end

data/spec/fixtures/actual_rank.txt

@@ -0,0 +1,26 @@
+Z
+Y
+X
+W
+V
+U
+T
+S
+R
+Q
+P
+O
+N
+M
+L
+K
+J
+I
+H
+G
+F
+E
+D
+C
+B
+A

data/spec/fixtures/perfect_rank.txt

@@ -0,0 +1,26 @@
+A
+B
+C
+D
+E
+F
+G
+H
+I
+J
+K
+L
+M
+N
+O
+P
+Q
+R
+S
+T
+U
+V
+W
+X
+Y
+Z

data/spec/fixtures/repeated_rank.txt

@@ -0,0 +1,5 @@
+hot
+hot
+fresh
+vip
+piv

data/spec/rankum/metrics/fcp_calculator_spec.rb

@@ -0,0 +1,76 @@
+require_relative "../../../lib/rankum/metrics/fcp_calculator"
+require_relative "../../../lib/rankum/utils/fcp_pair"
+
+module Rankum
+  module Metrics
+    describe FCPCalculator do
+      let(:perfect_rank) { ["A", "B", "C", "D", "E"] }
+      let(:reader) do
+        double("rank_reader", :perfect_rank => perfect_rank, :actual_rank => actual_rank)
+      end
+
+      context "when actual rank is equal to perfect rank" do
+        let(:actual_rank) { perfect_rank }
+
+        it "should get 1.0 as FCP value" do
+          calculator = FCPCalculator.run(rank_reader: reader)
+          expect(calculator).to be_a_success
+          expect(calculator.value).to eq(1.0)
+        end
+      end
+
+      context "when actual rank is totally different from the perfect one" do
+        let(:actual_rank) { ["F", "G", "H", "I", "J"] }
+
+        it "should get 0 as FCP value" do
+          calculator = FCPCalculator.run(rank_reader: reader)
+          expect(calculator).to be_a_success
+          expect(calculator.value).to eq(0)
+        end
+      end
+
+      context "when actual rank is the reversed from the perfect one" do
+        let(:actual_rank) { ["E", "D", "C", "B", "A"] }
+
+        it "should get 0 as FCP value" do
+          calculator = FCPCalculator.run(rank_reader: reader)
+          expect(calculator).to be_a_success
+          expect(calculator.value).to eq(0)
+        end
+      end
+
+      context "when some pairs are incorrect" do
+        let(:actual_rank) { ["B", "A", "C", "E", "D"] }
+
+        it "should get 0.8 as FCP value" do
+          calculator = FCPCalculator.run(rank_reader: reader)
+          expect(calculator).to be_a_success
+          expect(calculator.value).to eq(0.8)
+        end
+      end
+
+      context "when has duplicated pairs and one wrong position" do
+        let(:perfect_rank) { ["hot", "hot", "fresh", "vip", "piv"] }
+        let(:actual_rank) { ["hot", "hot", "fresh", "piv", "vip"] }
+
+        it "should get 0.9 as FCP value" do
+          calculator = FCPCalculator.run(rank_reader: reader)
+          expect(calculator).to be_a_success
+          expect(calculator.value).to eq(0.9)
+        end
+      end
+
+      context "when duplicated pairs do not occur on actual rank" do
+        let(:perfect_rank) { ["hot", "hot", "fresh", "vip", "piv"] }
+        let(:actual_rank) { ["hot", "fresh", "fresh", "vip", "piv"] }
+
+        it "should get 0.7 as FCP value" do
+          calculator = FCPCalculator.run(rank_reader: reader)
+          expect(calculator).to be_a_success
+          expect(calculator.value).to eq(0.7)
+        end
+      end
+
+    end
+  end
+end

data/spec/rankum/readers/rank_file_reader_spec.rb

@@ -0,0 +1,49 @@
+require_relative "../../../lib/rankum/readers/rank_file_reader"
+
+module Rankum
+  module Readers
+    describe RankFileReader do
+      let(:subject) { RankFileReader.new }
+
+      context "when adding a path to the perfect rank as a txt file" do
+        let(:perfect_rank_path) { "spec/fixtures/perfect_rank.txt" }
+        before { subject.add_perfect_rank_path(perfect_rank_path) }
+
+        it "should convert to a list" do
+          expect(subject.perfect_rank).to be_a_kind_of(Array)
+        end
+
+        it "should add position number to each item rank" do
+          expected_list = ("A".."Z").to_a
+          expect(subject.perfect_rank).to eq(expected_list)
+        end
+      end
+
+      context "when adding a path to the actual rank as a txt file" do
+        let(:actual_rank_path) { "spec/fixtures/actual_rank.txt" }
+        before { subject.add_actual_rank_path(actual_rank_path) }
+
+        it "should convert to a list" do
+          expect(subject.actual_rank).to be_a_kind_of(Array)
+        end
+
+        it "should add position number to each item rank" do
+          expected_list = ("A".."Z").to_a.reverse
+          expect(subject.actual_rank).to eq(expected_list)
+        end
+      end
+
+      context "when has repeated pairs" do
+        let(:rank_path) { "spec/fixtures/repeated_rank.txt" }
+        before { subject.add_perfect_rank_path(rank_path) }
+        let(:expected_list) { ["hot", "hot", "fresh", "vip", "piv"] }
+
+        it "should returned a ordered list" do
+          expect(subject.perfect_rank).to eq(expected_list)
+        end
+      end
+
+    end
+  end
+end
+

data/spec/rankum/runners/cli_outputer_spec.rb

@@ -0,0 +1,36 @@
+require_relative "../../../lib/rankum/runners/cli_outputer"
+
+module Rankum
+  module Runners
+    describe CLIOutputer do
+
+      context "when has a result value" do
+        it "should round value" do
+          result = CLIOutputer.run(value: 0.4242)
+
+          expect(result).to be_a_success
+          expect(result.value).to eq(42.42)
+        end
+
+        it "should return output lines" do
+          result = CLIOutputer.run(value: 0.4242, metric: "FCP")
+          output = result.output
+
+          expect(result).to be_a_success
+          expect(output[0]).to eq("Rankum")
+          expect(output[1]).to match(/-.*/)
+          expect(output[2]).to match(/Metric: [\s|\S].*/)
+          expect(output[3]).to eq("Similarity: #{Paint["42.42 %", :red, :bright]}")
+        end
+      end
+
+      context "when result is nil" do
+        it "should fail" do
+          result = CLIOutputer.run
+          expect(result).to be_a_fail
+        end
+      end
+
+    end
+  end
+end

data/spec/rankum/runners/cli_setup_spec.rb

@@ -0,0 +1,36 @@
+require_relative "../../../lib/rankum/runners/cli_setup"
+
+module Rankum
+  module Runners
+    describe CLISetup do
+
+      context "when receiving valid parameters" do
+        let(:cli_params) do
+          {
+            metric: "fcp",
+            rank_reader: "RankFileReader",
+            perfect_rank: "spec/fixtures/perfect_rank.txt",
+            actual_rank: "spec/fixtures/actual_rank.txt"
+          }
+        end
+
+        it "should set up parameters" do
+          result = CLISetup.run(cli_params)
+
+          expect(result).to be_a_success
+          expect(result.rank_reader).to be_a_kind_of(Rankum::Readers::RankFileReader)
+        end
+
+        it "should add ranks to rank file reader" do
+          reader = CLISetup.run(cli_params).rank_reader
+          list = ("A".."Z").to_a
+          reversed_list = ("A".."Z").to_a.reverse
+
+          expect(reader.perfect_rank).to eq(list)
+          expect(reader.actual_rank).to eq(reversed_list)
+        end
+      end
+    end
+  end
+end
+

data/spec/rankum/utils/fcp_pair_spec.rb

@@ -0,0 +1,35 @@
+require_relative "../../../lib/rankum/utils/fcp_pair"
+
+module Rankum
+  module Utils
+    describe FCPPair do
+
+      context "when receiving a rank as an array" do
+        let(:rank) { ["A", "A", "C", "D", "E"] }
+        let(:pair_array) { [ Pair.new("A","A"), Pair.new("A","C"), Pair.new("A","D"), Pair.new("A", "E"),
+                        Pair.new("A","C"), Pair.new("A","D"), Pair.new("A", "E"),
+                        Pair.new("C","D"), Pair.new("C","E"),
+                        Pair.new("D", "E") ] }
+
+        let(:pair_hash) do
+          { Pair.new("A","A") => 1,
+            Pair.new("A","C") => 2,
+            Pair.new("A","D") => 2,
+            Pair.new("A", "E") => 2,
+            Pair.new("C","D") => 1,
+            Pair.new("C","E") => 1,
+            Pair.new("D", "E") => 1 }
+        end
+
+        it "should return an array of pairs" do
+          expect(FCPPair.to_a(rank)).to eq(pair_array)
+        end
+
+        it "should return a hash of pair occurences" do
+          expect(FCPPair.to_h(rank)).to eq(pair_hash)
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: rankum
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Felipe Besson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A gem to compare search ranks using flexible quality rank metrics
+email: flpbesson@gmail.com
+executables:
+- rankum
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/rankum
+- lib/rankum.rb
+- lib/rankum/metrics/fcp_calculator.rb
+- lib/rankum/readers/rank_file_reader.rb
+- lib/rankum/runners/cli_outputer.rb
+- lib/rankum/runners/cli_setup.rb
+- lib/rankum/runners/rankum_cli.rb
+- lib/rankum/utils/fcp_pair.rb
+- lib/rankum/utils/interactor.rb
+- rankum.gemspec
+- spec/fixtures/actual_rank.txt
+- spec/fixtures/perfect_rank.txt
+- spec/fixtures/repeated_rank.txt
+- spec/rankum/metrics/fcp_calculator_spec.rb
+- spec/rankum/readers/rank_file_reader_spec.rb
+- spec/rankum/runners/cli_outputer_spec.rb
+- spec/rankum/runners/cli_setup_spec.rb
+- spec/rankum/utils/fcp_pair_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/besson/rankum
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Measure search rank quality
+test_files:
+- spec/fixtures/actual_rank.txt
+- spec/fixtures/perfect_rank.txt
+- spec/fixtures/repeated_rank.txt
+- spec/rankum/metrics/fcp_calculator_spec.rb
+- spec/rankum/readers/rank_file_reader_spec.rb
+- spec/rankum/runners/cli_outputer_spec.rb
+- spec/rankum/runners/cli_setup_spec.rb
+- spec/rankum/utils/fcp_pair_spec.rb
+- spec/spec_helper.rb