hide_and_seek 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6bf4e77c74f301d4926d042aa2c214737f8313d
-  data.tar.gz: 6a75a4359ffbeafc02e699082621fdee30b8b028
+  metadata.gz: e211ac4514e856978526436d162c72fb8a9f93ca
+  data.tar.gz: 8244ea52ff3ef1f62b3c1a751849deac3882dece
 SHA512:
-  metadata.gz: fee4d3701b107bc43e39cefa779c59c01453ed03d5605bb4cb06dbf1729919ce338bb16c37b85062ac145be39b1ba1e52b63e4c61735b487c5ff9966d31ed513
-  data.tar.gz: 6d66a72405dc445aec7fcd8be513d05d6b489d2c6a1d743d39274e0218955645e0eb03b34aab4d70a6d522383d890211ada45bb563ea2895c94273065c13c074
+  metadata.gz: 5cc6990c1e8ba613dc1758c3778cc532a5ed41e96a303ea516dc6746a42204df3c8a53f3c8fa47a91a566152c068f6ce359cb2d0698bf0a226c1ef57fcc1f668
+  data.tar.gz: 2f409298c88886922477c68e0f3be84d196d34cec3ed11b425f09c0e6f6292e2e3571989414fda7988f763d2fed7d03b5777763bc70453f708ec016994f91b3c

data/app/controllers/hide_and_seek/items_controller.rb

@@ -2,12 +2,10 @@ require_dependency "hide_and_seek/application_controller"
 
 module HideAndSeek
   class ItemsController < ApplicationController
-    before_filter :determine_identifier
-
     def show
       respond_to do |format|
         format.json {
-          render json: [display: $hide_and_seek.display?(params[:id], @id)]
+          render json: [display: hide_and_seek.display?]
         }
       end
     end
@@ -15,20 +13,24 @@ module HideAndSeek
     def update
       respond_to do |format|
         format.json do
-          if $hide_and_seek.hide(params[:id], @id)
+          if hide_and_seek.hide
             render status: 200, json: [true]
           else
             render status: 502, json: [false]
           end
         end
       end
+    end
 
+    def hide_and_seek
+      @hide_and_seek ||= HideAndSeek::Item.new(params[:item_name], user_identifier)
     end
+    hide_action :hide_and_seek
 
     private
-    def determine_identifier
-      @id = params[:user_id] || current_user.id
-    end
 
+    def user_identifier
+      params[:user_id] || current_user.id
+    end
   end
 end

data/app/models/hide_and_seek/item.rb

@@ -1,28 +1,26 @@
 class HideAndSeek::Item
-  attr_accessor :item_name, :user_identifier
+  cattr_accessor :storage, instance_writer: false
+  attr_reader :item_name, :user_identifier
 
-  def initialize(storage)
-    @storage = storage
-  end
-
-  def display?(item_name, user_identifier)
+  def initialize(item_name, user_identifier)
     @item_name = item_name
     @user_identifier = user_identifier
-    return false if $redis.exists(key_name)
+  end
+
+  def display?
+    return false if storage.exists(key_name)
     return true
   end
 
-  def hide(item_name, user_identifier)
-    @item_name = item_name
-    @user_identifier = user_identifier
-    if $redis.set(key_name, Time.now) == "OK"
+  def hide
+    if storage.set(key_name, Time.current) == "OK"
       return true
     end
     return false
   end
 
   def key_name
-    "#{@item_name}-#{@user_identifier}"
+    "#{item_name}-#{user_identifier}"
   end
 
 end

data/config/routes.rb

@@ -1,3 +1,3 @@
 HideAndSeek::Engine.routes.draw do
-  resources :items, only: [:show, :update]
+  resources :items, only: [:show, :update], param: :item_name
 end

data/lib/hide_and_seek/engine.rb

@@ -7,7 +7,7 @@ module HideAndSeek
     end
 
     Engine.routes.draw do
-      resources :items, only: [:show, :update]
+      resources :items, only: [:show, :update], param: :item_name
     end
   end
 end

data/lib/hide_and_seek/helpers.rb

@@ -0,0 +1,22 @@
+module HideAndSeek
+  module Helpers
+    # Checks if an item should be displayed for a
+    # given user.
+    # 
+    # @param item_name [String]
+    # @param user_identifier [Integer]
+    # @return [true, false]
+    def display?(item_name, user_identifier)
+      HideAndSeek::Item.new(item_name, user_identifier).display?
+    end
+
+    # Hides an item for a given user.
+    # 
+    # @param item_name [String]
+    # @param user_identifier [Integer]
+    # @return [true, false]
+    def hide(item_name, user_identifier)
+      HideAndSeek::Item.new(item_name, user_identifier).hide
+    end
+  end
+end

data/lib/hide_and_seek/version.rb

@@ -1,3 +1,3 @@
 module HideAndSeek
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/hide_and_seek/controllers/items_controller_spec.rb

@@ -1,55 +1,67 @@
-require 'spec_helper'
-
-describe HideAndSeek::ItemsController, :type => :controller do
+RSpec.describe HideAndSeek::ItemsController, :type => :controller do
   routes { HideAndSeek::Engine.routes }
 
-  let(:current_user){double("User", :id => 1)}
+  let(:current_user){ double("User", :id => 1) }
 
   before do
     allow(controller).to receive(:current_user).and_return(current_user)
   end
 
+  describe '#hide_and_seek' do
+    before { controller.params.merge!(item_name: 'foo') }
+
+    context 'when a user_id parameter has not been provided' do
+      it "instantiates a HideAndSeek::Item for the current user" do
+        expect(HideAndSeek::Item).to receive(:new).with('foo', 1)
+        controller.hide_and_seek
+      end
+    end
+
+    context 'when a user_id parameter has been provided' do
+      before { controller.params.merge!(user_id: 9001) }
+
+      it "instantiates a HideAndSeek::Item for the requested user" do
+        expect(HideAndSeek::Item).to receive(:new).with('foo', 9001)
+        controller.hide_and_seek
+      end
+    end
+  end
 
-  context "#show" do
+  describe "#show" do
     it "should check hide_and_seek with the id and the current user" do
-      expect($hide_and_seek).to receive(:display?).with("foo", 1).and_return(true)
-      get :show, id: "foo", format: :json
+      expect_any_instance_of(HideAndSeek::Item).to receive(:display?).and_return(true)
+      get :show, item_name: "foo", format: :json
     end
+
     it "should render json display => true if successful" do
-      allow($hide_and_seek).to receive(:display?).and_return true
-      get :show, id: "foo", format: :json
+      allow_any_instance_of(HideAndSeek::Item).to receive(:display?).and_return true
+      get :show, item_name: "foo", format: :json
       expect(response.body).to eq([display: true].to_json)
     end
+
     it "should render json display => false if unsuccessful" do
-      allow($hide_and_seek).to receive(:display?).and_return false
-      get :show, id: "foo", format: :json
+      allow_any_instance_of(HideAndSeek::Item).to receive(:display?).and_return false
+      get :show, item_name: "foo", format: :json
       expect(response.body).to eq([display: false].to_json)
     end
-    it "should params[:user_id] over current_user if sent" do
-      expect($hide_and_seek).to receive(:display?).with("foo", 9001).and_return(true)
-      get :show, id: "foo", format: :json, user_id: 9001
-    end
   end
 
-  context "#update" do
+  describe "#update" do
     it "should hide the item for the current_user" do
-      expect($hide_and_seek).to receive(:hide).with("foo", 1)
-      patch :update, id: "foo", format: :json
+      expect_any_instance_of(HideAndSeek::Item).to receive(:hide)
+      patch :update, item_name: "foo", format: :json
     end
+
     it "should render 200" do
-      allow($hide_and_seek).to receive(:hide).and_return true
-      patch :update, id: "foo", format: :json
+      allow_any_instance_of(HideAndSeek::Item).to receive(:hide).and_return true
+      patch :update, item_name: "foo", format: :json
       expect(response.status).to eq(200)
     end
+
     it "should respond with 502 if it can't be saved." do
-      allow($hide_and_seek).to receive(:hide).and_return false
-      patch :update, id: "foo", format: :json
+      allow_any_instance_of(HideAndSeek::Item).to receive(:hide).and_return false
+      patch :update, item_name: "foo", format: :json
       expect(response.status).to eq(502)
     end
-    it "should params[:user_id] over current_user if sent" do
-      expect($hide_and_seek).to receive(:hide).with("foo", 9001).and_return(true)
-      patch :update, id: "foo", format: :json, user_id: 9001
-    end
-
   end
 end

data/spec/hide_and_seek/models/item_spec.rb

@@ -1,45 +1,39 @@
-require 'spec_helper'
-
-describe HideAndSeek::Item, :type => :model do
-  before do
-    $redis = double(:exists => true, :set => "OK")
-  end
-
-  subject{HideAndSeek::Item.new $redis}
+RSpec.describe HideAndSeek::Item, :type => :model do
+  before { described_class.storage = storage }
+  after { described_class.storage = nil }
+  let(:storage) { double(:exists => true, :set => "OK") }
+  subject(:item) { described_class.new('foo', 1) }
 
   describe "#display?" do
     it "should return false if key exists" do
-      allow($redis).to receive(:exists).with("foo-1").and_return true
-      expect(subject.display?("foo", 1)).to be false
+      allow(storage).to receive(:exists).with("foo-1").and_return true
+      expect(item.display?).to be false
     end
     it "should return true if key doesn't exist" do
-      allow($redis).to receive(:exists).with("foo-1").and_return false
-      expect(subject.display?("foo", 1)).to be true
+      allow(storage).to receive(:exists).with("foo-1").and_return false
+      expect(item.display?).to be true
     end
   end
 
   describe "#key_name" do
-    it "should join the item name and the user identifier" do
-      subject.item_name = "foo"
-      subject.user_identifier = 1
-      expect(subject.key_name).to eql "foo-1"
+    it "joins the item_name and user_identifier." do
+      expect(described_class.new('foo', 1).key_name).to eq('foo-1')
     end
-
   end
 
   describe "#hide" do
     it "should receive a key with the current time" do
-      expect($redis).to receive(:set).with("foo-1", anything())
-      subject.hide("foo", 1)
+      expect(storage).to receive(:set).with("foo-1", anything())
+      item.hide
     end
     it "should return true if successful" do
-      allow($redis).to receive(:set).with("foo-1", anything()).and_return "OK"
-      expect(subject.hide("foo", 1)).to be true
+      allow(storage).to receive(:set).with("foo-1", anything()).and_return "OK"
+      expect(item.hide).to be true
     end
 
     it "should return false if unsuccessful" do
-      allow($redis).to receive(:set).and_return "FALSE"
-      expect(subject.hide("foo", 1)).to be false
+      allow(storage).to receive(:set).and_return "FALSE"
+      expect(item.hide).to be false
     end
   end
 end

data/spec/internal/config/initializers/hide_and_seek.rb

@@ -1,6 +1,6 @@
 require 'redis'
 require 'redis-namespace'
 
-$redis = Redis.new(logger: Rails.logger)
-$ns = Redis::Namespace.new("hide-and-seek-#{Rails.env}", :redis => $redis)
-$hide_and_seek = HideAndSeek::Item.new($ns)
+redis = Redis.new(logger: Rails.logger)
+ns = Redis::Namespace.new("hide-and-seek-#{Rails.env}", :redis => redis)
+HideAndSeek::Item.storage = ns

data/spec/lib/hide_and_seek/helpers_spec.rb

@@ -0,0 +1,30 @@
+require 'hide_and_seek/helpers'
+
+RSpec.describe HideAndSeek::Helpers, type: :helper do
+  let(:storage) { double(exists: true, set: 'OK') }
+  before { HideAndSeek::Item.storage = storage }
+
+  describe '#display?' do
+    it "instantiates a HideAndSeek::Item with the given item_name and user_identifier" do
+      expect(HideAndSeek::Item).to receive(:new).with('foo', 1).and_call_original
+      helper.display?('foo', 1)
+    end
+
+    it "calls #display? on the HideAndSee::Item instance" do
+      expect_any_instance_of(HideAndSeek::Item).to receive(:display?).once.and_call_original
+      helper.display?('foo', 1)
+    end
+  end
+
+  describe '#hide' do
+    it "instantiates a HideAndSeek::Item with the given item_name and user_identifier" do
+      expect(HideAndSeek::Item).to receive(:new).with('foo', 1).and_call_original
+      helper.hide('foo', 1)
+    end
+
+    it "calls #hide on the HideAndSee::Item instance" do
+      expect_any_instance_of(HideAndSeek::Item).to receive(:hide).once.and_call_original
+      helper.hide('foo', 1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -22,8 +22,8 @@ RSpec.configure do |config|
   config.use_transactional_fixtures = true
   config.infer_base_class_for_anonymous_controllers = false
   config.order = "random"
+  config.disable_monkey_patching!
 end
 
 RSpec.configure do |config|
-  $redis = Redis.new
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hide_and_seek
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - BJ Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-12 00:00:00.000000000 Z
+date: 2015-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -115,6 +115,7 @@ files:
 - config/routes.rb
 - lib/hide_and_seek.rb
 - lib/hide_and_seek/engine.rb
+- lib/hide_and_seek/helpers.rb
 - lib/hide_and_seek/version.rb
 - lib/tasks/hide_and_seek_tasks.rake
 - spec/hide_and_seek/controllers/items_controller_spec.rb
@@ -159,6 +160,7 @@ files:
 - spec/internal/public/422.html
 - spec/internal/public/500.html
 - spec/internal/public/favicon.ico
+- spec/lib/hide_and_seek/helpers_spec.rb
 - spec/spec_helper.rb
 homepage: http://www.github.com/goldstar/hide_and_seek
 licenses:
@@ -227,5 +229,6 @@ test_files:
 - spec/internal/public/favicon.ico
 - spec/internal/Rakefile
 - spec/internal/README.rdoc
+- spec/lib/hide_and_seek/helpers_spec.rb
 - spec/spec_helper.rb
 has_rdoc: