likes 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f168d5f36ca20484399058ad67d22ca0962f2ffd
-  data.tar.gz: db2cc8cf0d5b1dd4cefcf14fad30b2d0787c19ef
+  metadata.gz: 6148191736d05b2de8dce7c05ad3ec5781a70735
+  data.tar.gz: fdc47aec630718afa84d9c79f25e7a82bf71e8e5
 SHA512:
-  metadata.gz: 24d2aed90f4038fbcb2c3563a0ceca7587eefd75adbd57f17a812e61a24eb1b04af435b2551c39cf1c0e1629e74ded23392ee25f39cf61a84b7bd8c1cbea6ffe
-  data.tar.gz: 369523bb064ce679b8bc80c7cf431656da02257c2a46111f2028d59cb11ad0c204f81a23a922b41854291cb129a17bbbd0bc7a554d4bec0de927f6e07cab97b8
+  metadata.gz: 6f3b0458b662807a8ba0558be63846421a8d95a1bb0d64729419aeb08b58d0f6dfafa0fe4ff91fd3fae464833152d7ef8827fdea901106bf69dc360d0bee7033
+  data.tar.gz: 6e8d085e9022c1ead5877416f48b250bcd2036e62ce442d345156556bb2cfc461961efecf78cc0a89f181511983b071783f29087b20df26fd91a4f0726b37c8d

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in likes.gemspec
 gemspec
+
+gem "rspec"
+gem "yard"

data/README.md

@@ -1,6 +1,6 @@
 # Likes
 
-Give it a list of people and their likings and it will tell it what else could these people like.
+Give it a list of people and their likings and it will tell what else could these people like.
 
 This is a ruby gem.
 
@@ -22,9 +22,9 @@ Or install it yourself as:
 
 ## Usage
 
-*Not implemented yet*
-
 ```ruby
+require "likes"
+
 likeset = Likes::Set.new([
   Likes::Like.new(person: 1, item: 1),
   Likes::Like.new(person: 1, item: 5),

data/lib/likes/like.rb

@@ -0,0 +1,46 @@
+module Likes
+  # Job: Understands relation between person and the item they like
+  class Like
+    # Creates new instance of Like
+    #
+    # @param [Hash] attributes The attributes to create Like instance with
+    # @option attributes [Person#==] :person The person under the question. Required
+    # @option attributes [Item#==] :item The item person like. Required
+    def initialize(attributes={})
+      @person = fetch_required_attribute(attributes, :person)
+      @item = fetch_required_attribute(attributes, :item)
+    end
+
+    # Tests other object for equality with itself. Objects of type
+    # different from Like are considered non-equal.
+    #
+    # @param [Any, Like] other Other object to test for equality
+    # @return [TrueClass, FalseClass] Returns true if objects are
+    #   equal, false otherwise
+    def ==(other)
+      return false unless Like === other
+      self.person == other.person &&
+        self.item == other.item
+    end
+
+    # @private
+    def add_item_to_map(map)
+      (map[person] ||= []) << item
+    end
+
+    # @private
+    def add_person_to_map(map)
+      (map[item] ||= []) << person
+    end
+
+    protected
+
+    attr_reader :person, :item
+
+    private
+
+    def fetch_required_attribute(attributes, name)
+      attributes.fetch(name) { raise ArgumentError.new("Attribute #{name} is required") }
+    end
+  end
+end

data/lib/likes/set.rb

@@ -0,0 +1,147 @@
+module Likes
+  # Job: Understands patterns in people likings
+  class Set
+    # Creates new instance of Set
+    #
+    # @param [Array<Like>] likes List of likes
+    def initialize(likes)
+      @likes = likes
+      build_likes_of
+      build_liked
+    end
+
+    # Provides list of recommendations for person based on this
+    # likeset
+    #
+    # Should handle amount of distinct persons <= 10**6 and amount of
+    # distinct items <= 10**6, but likeset length is <= 10**7, ie it
+    # is advised to use only recent likes (couple of weeks or month)
+    #
+    # Worst approximation of execution time:
+    #
+    # Given K = how much likes target person has, in reasonable
+    #   situations it is not very big number
+    #
+    # Given N = how much distinct persons we have
+    #
+    # Complexity: O(NK)
+    #
+    # @param [Person#==] person The person to provide recommendations
+    #   for
+    # @return [Array<Item>] List of recommendations for the person
+    def recommendations_for(person)
+      Recommendations.new(person, likes_of, liked).solve
+    end
+
+    private
+
+    attr_accessor :likes, :likes_of, :liked
+
+    def build_likes_of
+      @likes_of = {}
+      likes.each do |like|
+        like.add_item_to_map(likes_of)
+      end
+    end
+
+    def build_liked
+      @liked = {}
+      likes.each do |like|
+        like.add_person_to_map(liked)
+      end
+    end
+
+    # @private
+    # Job: Understands which items could be recommended
+    class Recommendations
+      def initialize(person, likes_of, liked)
+        @intersections = Intersections.new(person)
+        @likes_of = likes_of
+        @liked = liked
+        @its_likes = likes_of.fetch(person)
+        add_similar_tastes
+      end
+
+      def solve
+        solution_candidate(intersections.next_people_with_similar_tastes)
+      end
+
+      private
+
+      attr_reader :intersections, :likes_of, :liked, :its_likes
+
+      def solution_candidate(candidates)
+        return [] if candidates.empty?
+        non_empty_solution(_solution_candidate(candidates))
+      end
+
+      def _solution_candidate(candidates)
+        candidates.map { |other_person, _|
+          likes_of.fetch(other_person) - its_likes
+        }.flatten.uniq
+      end
+
+      def non_empty_solution(solution)
+        return solve if solution.empty?
+        solution
+      end
+
+      def add_similar_tastes
+        its_likes.each do |item|
+          intersections.add_similar_tastes(liked.fetch(item))
+        end
+      end
+    end
+
+    # @private
+    # Job: Understands similar tastes
+    class Intersections
+      NO_LIMIT = Object.new.freeze
+
+      def initialize(person)
+        @sizes = {}
+        @person = person
+        @best_size = NO_LIMIT
+      end
+
+      def add_similar_tastes(people)
+        people.each do |other_person|
+          next if person == other_person
+          sizes[other_person] = sizes.fetch(other_person, 0) + 1
+        end
+      end
+
+      def next_people_with_similar_tastes
+        candidates_with(next_best_size)
+      end
+
+      private
+
+      attr_reader :sizes, :person
+
+      def candidates_with(intersection_size)
+        return [] if no_limit?(intersection_size)
+        sizes.select { |_, size| intersection_size == size }
+      end
+
+      def next_best_size
+        @best_size = get_best_size(@best_size)
+      end
+
+      def get_best_size(limit)
+        sizes
+          .select { |_, size| in_limit?(size, limit) }
+          .map { |_, size| size }.max || NO_LIMIT
+      end
+
+      def in_limit?(size, limit)
+        return true if no_limit?(limit)
+        size < limit
+      end
+
+      def no_limit?(limit)
+        NO_LIMIT == limit
+      end
+    end
+  end
+end

data/lib/likes/version.rb

@@ -1,3 +1,3 @@
 module Likes
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/likes.rb

@@ -1,4 +1,6 @@
 require "likes/version"
+require "likes/like"
+require "likes/set"
 
 module Likes
   # Your code goes here...

data/likes.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Likes::VERSION
   spec.authors       = ["Alexey Fedorov"]
   spec.email         = ["waterlink000@gmail.com"]
-  spec.summary       = %q{Give it a list of people and their likings and it will tell it what else could these people like.}
-  spec.description   = %q{Give it a list of people and their likings and it will tell it what else could these people like. Made for a greater good.}
+  spec.summary       = %q{Give it a list of people and their likings and it will tell what else could these people like.}
+  spec.description   = %q{Give it a list of people and their likings and it will tell what else could these people like. Made for a greater good.}
   spec.homepage      = "https://github.com/waterlink/likes"
   spec.license       = "MIT"
 

data/spec/likes/like_spec.rb

@@ -0,0 +1,46 @@
+module Likes
+  RSpec.describe Like do
+    describe "creation" do
+      it "can be created with person and item" do
+        expect(Like.new(person: 1, item: 2)).to be_a(Like)
+      end
+
+      it "cannot be created without person and/or item" do
+        expect { Like.new(person: 1) }.to raise_error(ArgumentError, /item is required/)
+        expect { Like.new(item: 2) }.to raise_error(ArgumentError, /person is required/)
+        expect { Like.new }.to raise_error(ArgumentError, /is required/)
+      end
+
+      it "ignores excessive attributes" do
+        expect(Like.new(person: 1, item: 3, hello: "world")).to eq(Like.new(person: 1, item: 3))
+      end
+    end
+
+    describe "encapsulation" do
+      it "does not allow to access its data" do
+        expect { Like.new(person: 1, item: 2).person }.to raise_error(NoMethodError)
+        expect { Like.new(person: 1, item: 2).person = 3 }.to raise_error(NoMethodError)
+
+        expect { Like.new(person: 1, item: 2).item }.to raise_error(NoMethodError)
+        expect { Like.new(person: 1, item: 2).item = 3 }.to raise_error(NoMethodError)
+      end
+    end
+
+    describe "equality" do
+      it "is equal to another like with same person and item" do
+        expect(Like.new(person: 1, item: 2)).to eq(Like.new(person: 1, item: 2))
+      end
+
+      it "is not equal to another like with different person and/or item" do
+        expect(Like.new(person: 1, item: 2)).not_to eq(Like.new(person: 3, item: 2))
+        expect(Like.new(person: 1, item: 2)).not_to eq(Like.new(person: 1, item: 5))
+        expect(Like.new(person: 1, item: 2)).not_to eq(Like.new(person: 2, item: 4))
+      end
+
+      it "is not equal to different objects" do
+        expect(Like.new(person: 1, item: 2)).not_to eq(nil)
+        expect(Like.new(person: 1, item: 2)).not_to eq(Object.new)
+      end
+    end
+  end
+end

data/spec/likes/set_spec.rb

@@ -0,0 +1,85 @@
+module Likes
+  RSpec.describe Set do
+    let(:likeset) {
+      Likes::Set.new([
+        Likes::Like.new(person: 1, item: 1),
+        Likes::Like.new(person: 1, item: 5),
+        Likes::Like.new(person: 1, item: 4),
+        Likes::Like.new(person: 1, item: 7),
+
+        Likes::Like.new(person: 2, item: 1),
+        Likes::Like.new(person: 2, item: 3),
+        Likes::Like.new(person: 2, item: 5),
+        Likes::Like.new(person: 2, item: 4),
+
+        Likes::Like.new(person: 3, item: 3),
+        Likes::Like.new(person: 3, item: 2),
+        Likes::Like.new(person: 3, item: 5),
+        Likes::Like.new(person: 3, item: 4),
+        Likes::Like.new(person: 3, item: 9),
+      ])
+    }
+
+    describe "#recommendations_for" do
+      it "returns a list of items" do
+        expect(likeset.recommendations_for(1)).to be_a(Array)
+      end
+
+      it "returns right recommendations" do
+        expect(likeset.recommendations_for(1).sort).to eq([3])
+        expect(likeset.recommendations_for(2).sort).to eq([2, 7, 9])
+        expect(likeset.recommendations_for(3).sort).to eq([1])
+      end
+
+      context "when there is an identic match with other person" do
+        let(:likeset) {
+          Likes::Set.new([
+            Likes::Like.new(person: 1, item: 1),
+            Likes::Like.new(person: 1, item: 5),
+            Likes::Like.new(person: 1, item: 4),
+            Likes::Like.new(person: 1, item: 7),
+
+            Likes::Like.new(person: 2, item: 1),
+            Likes::Like.new(person: 2, item: 3),
+            Likes::Like.new(person: 2, item: 5),
+            Likes::Like.new(person: 2, item: 4),
+
+            Likes::Like.new(person: 4, item: 1),
+            Likes::Like.new(person: 4, item: 5),
+            Likes::Like.new(person: 4, item: 4),
+            Likes::Like.new(person: 4, item: 7),
+
+            Likes::Like.new(person: 3, item: 3),
+            Likes::Like.new(person: 3, item: 2),
+            Likes::Like.new(person: 3, item: 5),
+            Likes::Like.new(person: 3, item: 4),
+            Likes::Like.new(person: 3, item: 9),
+          ])
+        }
+
+        it "ignores identical candidates" do
+          expect(likeset.recommendations_for(1).sort).to eq([3])
+        end
+      end
+
+      context "when there is nothing to recommend" do
+        let(:likeset) {
+          Likes::Set.new([
+            Likes::Like.new(person: 1, item: 1),
+            Likes::Like.new(person: 1, item: 5),
+            Likes::Like.new(person: 1, item: 4),
+            Likes::Like.new(person: 1, item: 7),
+
+            Likes::Like.new(person: 4, item: 1),
+            Likes::Like.new(person: 4, item: 5),
+            Likes::Like.new(person: 4, item: 7),
+          ])
+        }
+
+        it "returns an empty solution" do
+          expect(likeset.recommendations_for(1).sort).to eq([])
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require "likes"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: likes
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Alexey Fedorov
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Give it a list of people and their likings and it will tell it what else
+description: Give it a list of people and their likings and it will tell what else
   could these people like. Made for a greater good.
 email:
 - waterlink000@gmail.com
@@ -47,13 +47,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/likes.rb
+- lib/likes/like.rb
+- lib/likes/set.rb
 - lib/likes/version.rb
 - likes.gemspec
+- spec/likes/like_spec.rb
+- spec/likes/set_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/waterlink/likes
 licenses:
 - MIT
@@ -77,6 +83,10 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Give it a list of people and their likings and it will tell it what else
-  could these people like.
-test_files: []
+summary: Give it a list of people and their likings and it will tell what else could
+  these people like.
+test_files:
+- spec/likes/like_spec.rb
+- spec/likes/set_spec.rb
+- spec/spec_helper.rb
+has_rdoc: