looksist 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71664ddcb9ae9f2c46b91072a8483ccc450b5570
-  data.tar.gz: 5ccb029a61016e3885c2b4b728c8e6d0b2a5a781
+  metadata.gz: 453912d57be9e4fc38f6616ffdce38e38f0385bb
+  data.tar.gz: 8f43edb7bf0cfd70addeabfc8fd999045d253599
 SHA512:
-  metadata.gz: 2a926878fba12379bbbdddef54c6547e816338d5105cb03e3c64f75ce69e4a29ac503ebb8dfa8ecf8dd988b937cd3a8ac75ceb83f162340056d7464f163f0269
-  data.tar.gz: 113af2b37ef8237d31d491a9f898144f6adb5ce1d4dd8b52acbef52d0c4dd7ece390e43d17747513d2a305a6386cf5be36bcfaa4137cf2ad6bfd9f85a595ac26
+  metadata.gz: 6b7044cc4641fa67c4842a4c0a534a9182a6a3518764927aec3087041fbbdc8916597af8b98b018e480f2ef01daf07211bbe34e974c8affaf7e850ea22377d10
+  data.tar.gz: fb977003fff907b27036af080f3a870b0b5a798f6ca668a63fa75b3441251bdbb9d2d93d4488543d0786b8ea351e324cd27776b8a114c0e66b4560fc08bcec60

data/README.md

@@ -1,14 +1,16 @@
-# Herdis
+# Looksist
 
 [![Build Status](https://travis-ci.org/jpsimonroy/herdis.png?branch=master)](https://travis-ci.org/jpsimonroy/herdis)
 
-TODO: Write a gem description
+looksist (adj) - forming positive prejudices based on appearances
+
+Use this gem when you have to lookup attributes from a key-value store based on another attribute as key. This supports redis out-of-the-box and it's blazing fast!
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'herdis'
+    gem 'looksist'
 
 And then execute:
 
@@ -16,16 +18,47 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install herdis
+    $ gem install looksist
 
 ## Usage
 
-TODO: Write usage instructions here
+* Add an initializer to configure looksist
+
+``` ruby
+Looksist.lookup_store_client ||= Redis.new(:url => (ENV['REDIS_URL'], :driver => :hiredis)
+Looksist.driver = Looksist::Serializers::Her
+```
+You need to specify the driver to manage the attributes. In this case, we use [HER](https://github.com/remiprev/her). You can add support for ActiveResource or ActiveRecord as needed (also refer to specs for free form usage without a driver).
+
+* Please find the sample rspec to understand the usage and internals
+
+``` ruby
+it 'should generate declarative attributes on the model with simple lookup value' do
+      module SimpleLookup
+        class Employee
+          include Looksist
+          attr_accessor :id
+          lookup :name, using= :id
+
+          def initialize(id)
+            @id = id
+          end
+        end
+      end
+
+      expect(Looksist.lookup_store_client).to receive(:get).with('ids/1').and_return('Employee Name')
+      e = SimpleLookup::Employee.new(1)
+      expect(e.name).to eq('Employee Name')
+end
+```
+lookup takes the following form:
+
+``` ruby
+lookup :name, using = :employee_id # will lookup "employees/#{employee_id}" from the store
+
+lookup :name, using = :employee_id, bucket_name="stars" # will lookup "stars/#{employee_id}" from the store
+
+lookup [:name, :location], using = :employee_id # will lookup "stars/#{employee_id}" from the store for an object with two attributes (name, location)
 
-## Contributing
+```
 
-1. Fork it ( https://github.com/[my-github-username]/herdis/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 a new Pull Request

data/lib/looksist.rb

@@ -1,4 +1,6 @@
 require 'looksist/version'
+require 'looksist/redis_service'
+require 'looksist/hashed'
 
 module Looksist
   extend ActiveSupport::Concern
@@ -19,7 +21,7 @@ module Looksist
         what.each do |method_name|
           define_method(method_name) do
             key = [bucket, '/', self.send(using).try(:to_s)].join('')
-            JSON.parse(send(:memoized, key))[method_name.to_s]
+            JSON.parse(send(:memoized, key) || '{}')[method_name.to_s]
           end
           self.lookup_attributes << method_name
         end

data/lib/looksist/hashed.rb

@@ -0,0 +1,42 @@
+module Looksist
+  module Hashed
+    extend ActiveSupport::Concern
+
+    # inject after: :assortment, at: 'table', using: :supplier_id, populate: :supplier_name, bucket_name: 'suppliers'
+
+    class << self;
+      attr_accessor :redis_service
+    end
+
+    module ClassMethods
+      def inject(opts)
+        raise 'Incorrect usage' unless [:after, :using, :populate].all? { |e| opts.keys.include? e }
+        @rules ||= {}
+        @rules[opts[:after]] ||= []
+        @rules[opts[:after]] << opts
+        return if @rules[opts[:after]].length > 1
+
+        define_method("#{opts[:after]}_with_inject") do
+          hash = send("#{opts[:after]}_without_inject".to_sym)
+          self.class.instance_variable_get(:@rules)[opts[:after]].each do |opts|
+            keys = hash[opts[:at]][opts[:using]]
+            entity_name = entity(opts[:using])
+            values = Hashed.redis_service.send("#{entity_name}_for", keys)
+            hash[opts[:at]][opts[:populate]] = values
+          end
+          hash
+        end
+
+        alias_method_chain opts[:after], :inject
+      end
+    end
+
+    included do |base|
+      base.class_attribute :rules
+    end
+
+    def entity(entity_id)
+      entity = entity_id.to_s.gsub('_id', '')
+    end
+  end
+end

data/lib/looksist/redis_service.rb

@@ -0,0 +1,54 @@
+module Looksist
+  class RedisService
+    attr_accessor :client, :buffer_size, :cache
+
+    def self.instance
+      @_instance_ ||= new
+      @_instance_.cache ||= {}
+      yield @_instance_ if block_given?
+      @_instance_.buffer_size ||= 50000
+      @_instance_
+    end
+
+    def method_missing(m, *args, &block)
+      if m.to_s.ends_with?("_for")
+        entity = m.to_s.gsub('_for', '')
+        args.first.is_a?(Array) ? find_all(entity, args.first) : find(entity, args.first)
+      else
+        super(m, args)
+      end
+    end
+
+    private
+
+    def find(entity, id)
+      key = redis_key(entity, id)
+      hit_or_miss(key) do
+        @client.get(key)
+      end
+    end
+
+
+    def find_all(entity, ids)
+      @client.pipelined do
+        ids.uniq.each do |id|
+          find(entity, id)
+        end
+      end
+      ids.each_with_object([]) { |k, acc| acc << cache[redis_key(entity, k)] }
+    end
+
+    def hit_or_miss(key, &block)
+      @cache[key] ||= lru(&block)
+    end
+
+    def lru
+      @cache.shift if @cache.length >= @buffer_size
+      yield
+    end
+
+    def redis_key(entity, id)
+      "#{entity.pluralize}/#{id}"
+    end
+  end
+end

data/lib/looksist/version.rb

@@ -1,3 +1,3 @@
 module Lookist
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/hashed_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe Looksist::Hashed do
+  before(:each) do
+    class MockRedis
+      def pipelined
+        yield
+      end
+    end
+
+    @mock = MockRedis.new
+    Looksist::Hashed.redis_service = Looksist::RedisService.instance do |lookup|
+      lookup.client = @mock
+    end
+  end
+
+
+  context 'inject ' do
+    it 'should inject single attribute to an existing hash' do
+      class HashService1
+        include Looksist::Hashed
+
+        def metrics
+          {
+              table: {
+                  employee_id: [1, 2]
+              }
+          }
+        end
+
+        inject after: :metrics, at: :table, using: :employee_id, populate: :employee_name
+      end
+
+      expect(@mock).to receive(:get).with('employees/1').and_return('emp 1')
+      expect(@mock).to receive(:get).with('employees/2').and_return('emp 2')
+
+      HashService1.new.metrics.should eq({table: {
+          employee_id: [1, 2],
+          employee_name: ['emp 1', 'emp 2']
+      }})
+    end
+
+    it 'should inject multiple attribute to an existing hash' do
+      class HashService
+        include Looksist::Hashed
+
+        def metrics
+          {
+              table: {
+                  employee_id: [5, 6],
+                  employer_id: [3, 4]
+              }
+          }
+        end
+
+        inject after: :metrics, at: :table, using: :employee_id, populate: :employee_name
+        inject after: :metrics, at: :table, using: :employer_id, populate: :employer_name
+      end
+
+      expect(@mock).to receive(:get).with('employees/5').and_return('emp 5')
+      expect(@mock).to receive(:get).with('employees/6').and_return('emp 6')
+
+      expect(@mock).to receive(:get).with('employers/3').and_return('empr 3')
+      expect(@mock).to receive(:get).with('employers/4').and_return('empr 4')
+
+      HashService.new.metrics.should eq({table: {
+          employee_id: [5, 6],
+          employer_id: [3, 4],
+          employee_name: ['emp 5', 'emp 6'],
+          employer_name: ['empr 3', 'empr 4']
+      }})
+    end
+  end
+
+
+  context 'multiple methods and injections' do
+    it 'should inject multiple attribute to an existing hash' do
+      class HashServiceSuper
+        include Looksist::Hashed
+
+        def shrinkage
+          {
+              table: {
+                  shrink_id: [1, 2]
+              }
+          }
+        end
+
+        def stock
+          {
+              table: {
+                  dc_id: [7, 8]
+              }
+          }
+        end
+
+        inject after: :shrinkage, at: :table, using: :shrink_id, populate: :shrink_name
+        inject after: :stock, at: :table, using: :dc_id, populate: :dc_name
+      end
+
+      expect(@mock).to receive(:get).with('shrinks/1').and_return('shrink 1')
+      expect(@mock).to receive(:get).with('shrinks/2').and_return('shrink 2')
+
+      expect(@mock).to receive(:get).with('dcs/7').and_return('dc 7')
+      expect(@mock).to receive(:get).with('dcs/8').and_return('dc 8')
+
+      hash_service_super = HashServiceSuper.new
+      hash_service_super.shrinkage.should eq({table: {
+          shrink_id: [1, 2],
+          shrink_name: ['shrink 1', 'shrink 2']
+      }})
+
+      hash_service_super.stock.should eq({table: {
+          dc_id: [7, 8],
+          dc_name: ['dc 7', 'dc 8']
+      }})
+    end
+
+  end
+end

data/spec/looksist_spec.rb

@@ -71,39 +71,49 @@ describe Looksist do
       module SimpleLookup
         class Employee
           include Looksist
-          attr_accessor :id
+          attr_accessor :id, :employee_id
           lookup :name, using= :id
+          lookup :unavailable, using= :employee_id
 
           def initialize(id)
-            @id = id
+            @id = @employee_id = id
           end
         end
       end
 
       expect(Looksist.lookup_store_client).to receive(:get).with('ids/1').and_return('Employee Name')
+      expect(Looksist.lookup_store_client).to receive(:get).with('employees/1').and_return(nil)
       e = SimpleLookup::Employee.new(1)
       expect(e.name).to eq('Employee Name')
+      expect(e.unavailable).to be(nil)
     end
 
     it 'should generate declarative attributes on the model with object based lookup value' do
       module CompositeLookup
         class Employee
           include Looksist
-          attr_accessor :id
+          attr_accessor :id, :employee_id
 
           lookup [:name, :location], using=:id
+          lookup [:age, :sex], using=:employee_id
 
           def initialize(id)
-            @id = id
+            @id = @employee_id = id
           end
         end
       end
 
       expect(Looksist.lookup_store_client).to receive(:get).with('ids/1')
                                               .and_return({name: 'Employee Name', location: 'Chennai'}.to_json)
+      expect(Looksist.lookup_store_client).to receive(:get).twice.with('employees/1')
+                                              .and_return(nil)
       e = CompositeLookup::Employee.new(1)
+
       expect(e.name).to eq('Employee Name')
       expect(e.location).to eq('Chennai')
+
+      expect(e.age).to be(nil)
+      expect(e.sex).to be(nil)
     end
   end
 end

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@ require 'active_support/all'
 require 'faraday_middleware'
 require 'her'
 require 'looksist'
+require 'looksist/redis_service'
+require 'looksist/hashed'
 require 'pry'
 
 module Her

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: looksist
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - RC
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-15 00:00:00.000000000 Z
+date: 2014-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -155,8 +155,11 @@ files:
 - README.md
 - Rakefile
 - lib/looksist.rb
+- lib/looksist/hashed.rb
+- lib/looksist/redis_service.rb
 - lib/looksist/version.rb
 - looksist.gemspec
+- spec/hashed_spec.rb
 - spec/looksist_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jpsimonroy/herdis
@@ -184,5 +187,6 @@ signing_key:
 specification_version: 4
 summary: Redis backed lookup for your her models
 test_files:
+- spec/hashed_spec.rb
 - spec/looksist_spec.rb
 - spec/spec_helper.rb