redstruct 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24f641b7af2b6207244ce2e1f6cc48b4ace00501
-  data.tar.gz: d313d71fb27eb36fd6fb6cb34c21709fa0e1f08e
+  metadata.gz: 7010bd0a452c39445eb106efd64f418019f49086
+  data.tar.gz: fcac9ed0f4261cdf9b83e39d8baf87f7d6f13823
 SHA512:
-  metadata.gz: b4a29bff10074805abbb590a238d5e302ab3d426148c60fced3a54af99970978a24fb39815f95f6e9a382af8ae4452bd47d989ca5674ebaa761b58649114296b
-  data.tar.gz: 82677b93e0bfd290d9c3733b30c00daeae115de057092931635b1178c18b974c04916fb334497a509703b92e1a5db0ea2eb9ba505500af3f405bace568cfca02
+  metadata.gz: 72a43e0e1df1868f8531db9a1d44b2b5e7735d062a063eeac2d970113ce462045869a12a812a3dc2ee7a950b51e0bc05fc9c69d1f6072153500beec9d6b0916f
+  data.tar.gz: 50853403b5514b16151701376584fc4f2906631a12ac7d30c8daa82c5e9e51580c655ba3b36c862c2768ec15f13264e6c93e8cccf055028085999fcdb9f51fac

data/README.md

@@ -32,6 +32,21 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Avoid using transactions; the Redis documentation suggests using Lua scripts where possible, as in most cases they will be faster than transactions. Use the `Redstruct::Utils::Scriptable` module and the `defscript` macro instead.
 
+## TODO
+
+[x] Implement counters
+[x] Implement locks (blocking/non-blocking)
+[x] Implement queues
+[x] Implement basic types (set, string, list, hash)
+[ ] Implement SortedSet
+[ ] Implement stacks
+[ ] Discuss supporting pipelining vs. just using lua scripts (better interface for scripted extensions?)
+[ ] Design/discuss stored factory meta-data (i.e. keep track of created objects, clear said objects, etc.)
+[ ] Implement/redesign factory such that types, hls, etc., packages add methods as necessary (or not? discuss)
+[ ] Implement collections to leverage redis commands such as mget, mset, etc.
+[ ] Implement value transformers (read and write) to make reusing types with specially encoded objects easy
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/npepinpe/redstruct.

data/Rakefile

@@ -9,10 +9,10 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test
 
-require 'redstruct/yard/defscript_handler'
+require 'yard/defscript_handler'
 YARD::Rake::YardocTask.new do |t|
- t.files   = ['lib/**/*.rb']
- t.options = ['--output-dir=./docs']
+  t.files   = ['lib/**/*.rb']
+  t.options = ['--output-dir=./docs']
 end

data/lib/redstruct/connection.rb

@@ -10,17 +10,35 @@ module Redstruct
       @pool = pool
     end
 
+    # Executes the given block by first fixing a thread local connection from the pool,
+    # such that all redis commands executed within the block are on the same connection.
+    # This is necessary when doing pipelining, or multi/exec stuff
+    # @return [Object] whatever the passed block evaluates to, nil otherwise
+    def with
+      result = nil
+      @pool.with do |c|
+        begin
+          Thread.current[:__redstruct_connection] = c
+          result = yield(c) if block_given?
+        ensure
+          Thread.current[:__redstruct_connection] = nil
+        end
+      end
+
+      return result
+    end
+
     # While slower on load, defining all methods that we want to pipe to one of the connections results in
     # faster calls at runtime, and gives us the convenience of not going through the pool.with everytime.
     Redis.public_instance_methods(false).each do |method|
       next if NON_COMMAND_METHODS.include?(method)
       class_eval <<~METHOD, __FILE__, __LINE__ + 1
-        def #{method}(*args)
+        def #{method}(*args, &block)
           connection = Thread.current[:__redstruct_connection]
           if connection.nil?
-            return @pool.with { |c| c.#{method}(*args) }
+            with { |c| c.#{method}(*args, &block) }
           else
-            return connection.#{method}(*args)
+            return connection.#{method}(*args, &block)
           end
         end
       METHOD

data/lib/redstruct/types/base.rb

@@ -15,17 +15,6 @@ module Redstruct
         @key = key
       end
 
-      def with
-        self.connection.pool.with do |c|
-          begin
-            Thread.current[:__redstruct_connection] = c
-            yield(c)
-          ensure
-            Thread.current[:__redstruct_connection] = nil
-          end
-        end
-      end
-
       def to_h
         return { key: @key }
       end

data/lib/redstruct/types/set.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Redstruct
   module Types
     # Note: keep in mind Redis converts everything to a string on the DB side
@@ -7,7 +8,8 @@ module Redstruct
       end
 
       def random(count: 1)
-        return self.connection.srandmember(@key, count.to_i)
+        list = self.connection.srandmember(@key, count)
+        return count == 1 ? list[0] : Set.new(list)
       end
 
       def empty?
@@ -69,7 +71,8 @@ module Redstruct
       end
 
       def pop(count: 1)
-        return self.connection.spop(@key, count.to_i)
+        list = self.connection.spop(@key, count)
+        return count == 1 ? list[0] : Set.new(list)
       end
 
       def remove(*members)
@@ -86,8 +89,6 @@ module Redstruct
           @factory.set(dest)
         when self.class
           dest
-        else
-          nil
         end
       end
       private :coerce_destination

data/lib/redstruct/types/struct.rb

@@ -15,18 +15,35 @@ module Redstruct
         self.connection.del(@key)
       end
 
-      def expire(ttl)
-        self.connection.expire(@key, ttl)
+      # Sets the key to expire after ttl seconds
+      # @param [Integer, #to_i] ttl the time to live in seconds (or milliseconds if ms is true)
+      # @param [Boolean] ms if true, assumes ttl is in milliseconds
+      def expire(ttl, ms: false)
+        if ms
+          self.connection.pexpire(@key, ttl.to_i)
+        else
+          self.connection.expire(@key, ttl.to_i)
+        end
       end
 
-      def expire_at(time)
-        self.connection.expire_at(@key,  time.to_i)
+      # Sets the key to expire at the given timestamp.
+      # @param [Time, Integer, #to_i] time time or unix timestamp at which the key should expire
+      # @param [Boolean] ms if true, assumes the timestamp is in milliseconds
+      def expire_at(time, ms: false)
+        if ms
+          time = (time.to_f * 1000) if time.is_a?(Time)
+          self.connection.pexpire_at(@key, time.to_i)
+        else
+          self.connection.expire_at(@key, time.to_i)
+        end
       end
 
+      # Removes the expiry time from a key
       def persist
         self.connection.persist(@key)
       end
 
+      # @return [String] the underlying redis type
       def type
         self.connection.type(@key)
       end

data/lib/redstruct/version.rb

@@ -1,3 +1,3 @@
 module Redstruct
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/lib/releaser/logger.rb

@@ -0,0 +1,15 @@
+require 'logger'
+
+module Releaser
+  class Logger < ::Logger
+    TAG = '[RELEASER]'.freeze
+
+    def info(message)
+      super(TAG) { message }
+    end
+
+    def error(message)
+      super(TAG) { message }
+    end
+  end
+end

data/lib/releaser/repository.rb

@@ -0,0 +1,32 @@
+require 'english'
+
+module Releaser
+  class Repository
+    attr_reader :path
+
+    def initialize(path = '.')
+      @path = File.expand_path(path)
+      raise(Error, 'Unreadable path given') unless File.readable?(@path)
+      raise(Error, 'Repository is not a directory') unless File.directory?(@path)
+      raise(Error, 'Repository is not a github repository') unless git?
+    end
+
+    def git?
+      File.directory?("#{@path}/.git")
+    end
+
+    def clean?
+      committed = `git status -s`.chomp.strip.empty?
+      pushed = `git log origin/master..HEAD`.chomp.strip.empty?
+
+      return committed && pushed
+    end
+
+    def fetch_remote_tags
+      `git fetch --tags`
+      return $CHILD_STATUS.success?
+    end
+
+    class Error < StandardError; end
+  end
+end

data/lib/tasks/release.rake

@@ -0,0 +1,49 @@
+require 'releaser/repository'
+
+repo = Releaser::Repository.new
+logger = Releaser::Logger.new($stdout)
+
+namespace :releaser do
+  namespace :repo do
+    desc 'Updates README, CHANGELOG, tags the release'
+    task :release do
+      unless repo.clean?
+        logger.error('Uncommitted/unpushed changes detected; aborting')
+        exit(-1)
+      end
+
+      repo.fetch_remote_tags
+
+      tasks = [:update_version, :update_readme, :update_changelog, :update_tags]
+      tasks.each do |task|
+        Rake::Task[task].invoke
+      end
+
+      repo.synchronize
+    end
+
+    desc 'Updates the current version'
+    task :update_version do
+      
+    end
+
+    desc 'Updates the README'
+    task :update_readme do
+    end
+
+    desc 'Updates the CHANGELOG'
+    task :update_changelog do
+    end
+
+    desc 'Tags release'
+    task :tag do
+    end
+  end
+
+  namespace :gem do
+    desc 'Ensures repo version exists, builds the gem, and pushes it'
+    task :release do
+
+    end
+  end
+end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: redstruct
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nicolas Pepin-Perreault
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-09 00:00:00.000000000 Z
+date: 2016-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
@@ -113,7 +119,10 @@ files:
 - lib/redstruct/utils/inspectable.rb
 - lib/redstruct/utils/scriptable.rb
 - lib/redstruct/version.rb
-- lib/redstruct/yard/defscript_handler.rb
+- lib/releaser/logger.rb
+- lib/releaser/repository.rb
+- lib/tasks/release.rake
+- lib/yard/defscript_handler.rb
 - test/redstruct/restruct_test.rb
 - test/test_helper.rb
 homepage: https://npepinpe.github.com/redstruct/
@@ -136,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Higher level data structures for Redis.