redislike 0.2.10 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93e338f19a009f64948a6968fa861b0c9a422e99b226d1b4eb44b9aa9c2daff3
-  data.tar.gz: f38e448cb56841ca2e95279b3a94da17b70629b9a01144230310250ac39261b3
+  metadata.gz: e9e7d2af78acf470ff2ce2935846897c3a51265b0cffa5cf1c4ca1fae7e6badf
+  data.tar.gz: cfcb15d58d797496e28259aadfc9c610d3ceab11f3ff8d58910d248918bc424c
 SHA512:
-  metadata.gz: c39910bf6dcedeb890f26a1187ebe0217b72c96c380b9586848cb9c670fa6f1cd39bfa3a2c3e609a06936d8efbf2990325d5aca50b4e3e1b2241acdf68653dda
-  data.tar.gz: 76675741dc9e5a70c154713e635da4c374dc47fa2b07ec7e84b0f5238a2fcc6d12520b7f103634a3a410e0154fb82a2c893354b4cdbbbb1c7086fb3b99c462d6
+  metadata.gz: 97b5bd69eb2ad93051d3c07bd3d7db65b5c5c8352dd6b282822dd41e4c7b55690388a4619a4c1429419db475c7b937ef3f0be7b078645bea5e01ff9fb8eae4ff
+  data.tar.gz: ab010af0e79aece8a0ab5b17cf2fd7725574dd1e4feb827a3c82e562aabd3305e7723a2437026f6d4df8cff9a729227e93555b3946cda3260712f12b0c5e3394

data/README.org

@@ -0,0 +1,105 @@
+#+TITLE: redislike - redis-like list operations for moneta
+#+LATEX: \pagebreak
+
+* Overview
+
+  ~redislike~ adds backend-independent support for redis-like list operations to
+  any Moneta datastore.
+
+* Supported Operations
+  
+  - BLPOP
+  - BRPOP
+  - BRPOPLPUSH
+  - LINDEX
+  - LINSERT
+  - LLEN
+  - LPOP
+  - LPUSH
+  - LPUSHX
+  - LRANGE
+  - LREM
+  - LSET
+  - LTRIM
+  - RPOP
+  - RPOPLPUSH
+  - RPUSH
+  - RPUSHX
+
+* Other Supported Operations
+
+  - EXISTS
+
+* Differences from Redis
+
+  - LSET with a non-existent list raises a =KeyError= rather than a =Redis::CommandError=.
+  - LSET with an out of range index raises an =IndexError= rather than a =Redis::CommandError=.
+
+* Installation
+
+  #+BEGIN_SRC shell
+    gem install redislike
+  #+END_SRC
+
+* Example
+
+  #+BEGIN_SRC ruby
+    require 'redislike'
+    datastore = Moneta.new :Memory, expires: true
+
+    datastore.lpush 'pending', 'foo'
+    datastore.rpoplpush 'pending', 'active'
+    puts datastore.lrange 'active', 0, -1
+  #+END_SRC
+
+  Returns =['foo']=
+
+* Motivation
+
+  Redis may be my favourite data store, for a number of reasons that have
+  nothing to do with this gem. It's also not a silver bullet. Like many tools,
+  used in the right context, it excels. Out of its element, it adds complexity
+  and overhead (when compared to using a tool better suited to that problem
+  domain).
+
+  Then there's Moneta, a lovely gem that provides a unified API to an impressive
+  range of backends for key/value storage. This allows low-effort integration
+  with whatever data store you already have. The consistency also enables
+  trivial swapping of backends as the evolution of an application guides
+  requirements, without rewriting much of anything.
+
+  To achive this consistency, Moneta omits support for backend-specfic features.
+  One of those that I often want is the (B)RPOPLPUSH list operation from Redis.
+  This takes an item from the tail of one list, and puts it at the head of
+  another list.
+
+  Rather than depending on a Redis backend for Moneta, and passing these
+  operations through to it, I built redis-like queue operations on top of
+  Moneta. Once those were in place, it seemed reasonable to continue and build
+  the rest.
+
+  At this point, some sort of scope began to take shape. The methods were
+  restructured to align with those provided by Redis, and tests were written to
+  guide this process.
+
+  **TL;DR: I wanted RPOPLPUSH in Moneta, didn't define scope boundaries and
+  accidentally reimplemented (some of) Redis.**
+
+* What's up with the tests?
+
+  Alright, so the tests are a bit unconventional, in the sense that you need a
+  working redis server to actually run the tests for a gem with the stated
+  intent of not requiring a redis server.
+
+  These tests that redislike is in fact, redis-like. These work by executing the
+  same instructions against redis, and an in-memory instance of redislike, and
+  asserting that the results should be the same.
+
+* License
+
+  ~redislike~ is available under the [[https://tldrlegal.com/license/mit-license][MIT License]]. See ~LICENSE.txt~ for the full
+  text.
+
+* Contributors
+
+  - [[https://colstrom.github.io/][Chris Olstrom]] | [[mailto:chris@olstrom.com][e-mail]] | [[https://twitter.com/ChrisOlstrom][Twitter]]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redislike
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
 platform: ruby
 authors:
 - Chris Olstrom
@@ -34,7 +34,7 @@ cert_chain:
   EIKh6yDoB+oCRuiTV0uw/lKE2PtbONhJb7uN1qhZqla/iBpmUjiEu8+skI+ygv9n
   7Krw8FJrV3+VRCiZTPKHeshAfL9yeIZh
   -----END CERTIFICATE-----
-date: 2018-03-15 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: moneta
@@ -66,7 +66,7 @@ files:
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
-- README.md
+- README.org
 - Rakefile
 - lib/redislike.rb
 - lib/redislike/helpers/lists.rb

data/README.md

@@ -1,84 +0,0 @@
-redislike
-=========
-
-For when we want Redis, but can't have nice things.
-
-redislike adds backend-independent support for redis-like list operations to any Moneta datastore.
-
-Supported Operations
---------------------
-* BLPOP
-* BRPOP
-* BRPOPLPUSH
-* LINDEX
-* LINSERT
-* LLEN
-* LPOP
-* LPUSH
-* LPUSHX
-* LRANGE
-* LREM
-* LSET
-* LTRIM
-* RPOP
-* RPOPLPUSH
-* RPUSH
-* RPUSHX
-
-Other Supported Operations
---------------------------
-* EXISTS
-
-Differences from Redis
-----------------------
-* LSET with a non-existent list raises a ```KeyError``` rather than a ```Redis::CommandError```.
-* LSET with an out of range index raises an ```IndexError``` rather than a ```Redis::CommandError```.
-
-Installation
-------------
-
-```gem install redislike```
-
-or in your Gemfile
-
-```gem 'redislike'```
-
-Example
------
-
-```
-require 'redislike'
-datastore = Moneta.new :Memory, expires: true
-
-datastore.lpush 'pending', 'foo'
-datastore.rpoplpush 'pending', 'active'
-puts datastore.lrange 'active', 0, -1
-```
-
-Should return ```['foo']```
-
-Motivation
-----------
-
-Redis may be my favourite data store, for a number of reasons that have nothing to do with this gem. It's also not a silver bullet. Like many tools, used in the right context, it excels. Out of its element, it adds complexity and overhead (when compared to using a tool better suited to that problem domain).
-
-Then there's Moneta, a lovely gem that provides a unified API to an impressive range of backends for key/value storage. This allows low-effort integration with whatever data store you already have. The consistency also enables trivial swapping of backends as the evolution of an application guides requirements, without rewriting much of anything.
-
-To achive this consistency, Moneta omits support for backend-specfic features. One of those that I often want is the (B)RPOPLPUSH list operation from Redis. This takes an item from the tail of one list, and puts it at the head of another list.
-
-Rather than depending on a Redis backend for Moneta, and passing these operations through to it, I built redis-like queue operations on top of Moneta. Once those were in place, it seemed reasonable to continue and build the rest.
-
-At this point, some sort of scope began to take shape. The methods were restructured to align with those provided by Redis, and tests were written to guide this process.
-
-**TL;DR: I wanted RPOPLPUSH in Moneta, didn't define scope boundaries and accidentally reimplemented (some of) Redis.**
-
-Dependencies
-------------
-* Moneta
-
-What's up with the tests?
--------------------------
-
-Alright, so the tests are a bit unconventional, in the sense that you need a working redis server to actually run the tests for a gem with the stated intent of not requiring a redis server.
-
-These tests that redislike is in fact, redis-like. These work by executing the same instructions against redis, and an in-memory instance of redislike, and asserting that the results should be the same.