savvy 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95186ba3a6494096fcac558c89fc868d8f790bde
-  data.tar.gz: 598b24403bac739d12b0d3c0b5b3ef9db3e275e4
+  metadata.gz: 28fa85fba714b4b39fd3723a0e82d9e9f8cc738f
+  data.tar.gz: 62d432c2a84b8b971f22470e8e31b22956e712d1
 SHA512:
-  metadata.gz: 4093c079265cfa65d1bdd34ed9111c86d360727a4a58d5664bf943ba0013bac696593a65d7dee8f9825f2d9fbe6719c67be920b9898d335bca9cf9d775c097fe
-  data.tar.gz: 0aed5f4081e6f689ea71471bbc85d1758e91cc06f7958a9f498e2af9e0cf758c6b929fa858a54c7666150337cd767d9c0810419e9245b9ee8683d393c2ee25f8
+  metadata.gz: 36c6c67963c9becef1b00424d30ac738e6de263ba21bff7b9dda27d2b90a7944237ead68804e6a3e7a001775d2015588644c12faaff663d287b7749494388e74
+  data.tar.gz: 9d6df66f86c22c58e82fc24951fdf2e88e606ffc6344958f391b510a15147d9ba1dd8a57f1452d7962f0ec828c229c6b1e29c1a951d47a95747e3eefb4579808

data/.travis.yml

@@ -3,7 +3,15 @@ dist: trusty
 cache: bundler
 language: ruby
 rvm:
-  - 2.2
-  - 2.3
-  - 2.4.0
+- 2.2
+- 2.3
+- 2.4.0
 before_install: gem install bundler -v 1.14.6
+services:
+  - redis-server
+notifications:
+  email:
+    on_success: never
+    on_failure: always
+  slack:
+    secure: d4aMjEF4rS1UGUilgyxObX/t1ZGJfrunNbZiDTssB2GjRvg1g6Z9sO3YrslK4BHlW+PcijDvH7eIhGheOgKA21LaPSnxlp/rqzPeIEh0yEZMmto2rPwecQicIjq0vu1C/EV/HPv8twzX65YpBYQHf9xZnX9y54J7QRrYpKIogJoEFsErwqOGvjQA4cWCfQQH3TdDrg+NdayMaWFiINdMNGqyIE1pxM80m2bT+nlE6o+YxOBd1lZZgh+3+Mm7r8PLjq3q7U8U3Avw+dS45PoEXQbnoKpdaXR5SUWRFyx+uH5itygiYb6F6rpPG9xuM7iUzz7PIJsRRkPO7tVXCPvlmGgWEiTFDEGc9Tsw9Kp739iGplWKtOBQzbrvf9mJfV/gViJdOpfpCOG5JCJWqTK8iSHe/m1LA36NOFll7tzd1NR6QBPLN4nb2y3bYjFdDlEh5N91ftIJAhkJEvg0+uMRZb4gd2ez4KxwzfGXSyYjS3HswBXmeCHuLFsEWyHaq5KjSdA3DfREUdU7B8PwP0sbEvTnzCKMnrUem4RJMwhNg8A+TtbXqLJsrxfjbKA0TkPNKpHqos74BJ+kh+ZvfnR7gD3yuG/WCXAIYzx4ET7OY97etpaqK3qVDrz/Bd1K/SEh4TtCE+lMkk6tFMtse6kUgg+tBzpA4mKkl0yVUoEMQfE=

data/lib/savvy.rb

@@ -9,6 +9,7 @@ require 'savvy/version'
 require 'savvy/configuration'
 require 'savvy/configuration_dsl'
 require 'savvy/environment_reader'
+require 'savvy/error'
 require 'savvy/root_finder'
 require 'savvy/utility'
 

data/lib/savvy/configuration.rb

@@ -43,9 +43,15 @@ module Savvy
       load_from_file!
     end
 
+    # Build a namespace that takes environmental and application factors into account.
+    #
+    # @param [<String>] parts additional parts that will be suffixed after the generated namespace
+    # @param [String] prefix a component that will appear before the savvy-generated namepsace
+    # @param [String] separator what separates the components used in the namespace
     # @return [String]
-    def build_namespace(*parts, separator: ?.)
+    def build_namespace(*parts, prefix: nil, separator: ?.)
       [
+        prefix,
         app_name,
         ( app_env if include_app_env? ),
         *parts

data/lib/savvy/configurators/redis.rb

@@ -3,41 +3,156 @@ module Savvy
     class Redis
       DEFAULT_SEPARATOR = ?:
 
-      # @!attribute [r] url
-      # @return [String]
-      attr_reader :url
+      PATH_PATTERN = %r{\A/(?<db>\d{1,2})(?:/(?<namespace_prefix>[^/]+))?}
+
+      # This is the namespace portion of a redis URI that
+      # is possibly set by the environment and will prefix
+      # the Savvy-generated namespace.
+      #
+      # @return [String, nil]
+      attr_reader :namespace_prefix
 
       # @param [Savvy::Config] config
       def initialize(config: Savvy.config)
         @config = config
-        @url = read_url_from_config
+
+        @db = 0
+        @namespace_prefix = nil
+
+        parse_url!
+      end
+
+      # @param [<String>] parts
+      # @param [Boolean] without_namespace return a configuration hash *only* as defined
+      # @return [{Symbol => Object}]
+      def config_hash(*parts, without_namespace: false)
+        check_validity!
+
+        {
+          host: @host,
+          port: @port,
+          db:   @db,
+        }.tap do |h|
+          ns = without_namespace ? @namespace_prefix : namespace(*parts)
+
+          h[:namespace] = ns unless ns.nil?
+        end
+      end
+
+      alias to_h config_hash
+
+      # @!attribute [r] db
+      # The database number used by redis.
+      # @return [Integer]
+      def db
+        check_validity!
+
+        @db
+      end
+
+      # @!attribute [r] host
+      # @return [String]
+      def host
+        check_validity!
+
+        @host
       end
 
       def namespace(*parts, separator: DEFAULT_SEPARATOR)
-        @config.build_namespace(*parts, separator: separator)
+        check_validity!
+
+        @config.build_namespace(*parts, prefix: @namespace_prefix, separator: separator)
       end
 
+      # @param [<String>] parts parts to add to the namespace
+      # @return [String]
       def namespaced_url(*parts)
-        "#{url}/#{namespace(*parts)}"
+        check_validity!
+
+        build_redis_url *parts
+      end
+
+      # @!attribute [r] port
+      # @return [Integer]
+      def port
+        check_validity!
+
+        @port
+      end
+
+      # The url as configured by the environment (sans namespace)
+      #
+      # @return [String]
+      def url
+        check_validity!
+
+        build_redis_url without_namespace: true
       end
 
       # @return [ConnectionPool]
       def build_connection_pool(*namespace_parts, size: 5, timeout: 5)
-        raise 'Requires connection_pool gem' unless defined?(ConnectionPool)
+        raise Savvy::RedisError, 'Requires connection_pool gem' unless defined?(ConnectionPool)
 
         ::ConnectionPool.new size: size, timeout: timeout do
           build_connection(*namespace_parts)
         end
       end
 
+      # @return [Redis::Namespace]
       def build_connection(*namespace_parts)
-        raise 'Requires redis-namespace gem' unless defined?(::Redis::Namespace)
+        raise Savvy::RedisError, 'Requires redis-namespace gem' unless defined?(::Redis::Namespace)
 
         ::Redis::Namespace.new(namespace(*namespace_parts), redis: ::Redis.new(url: url))
       end
 
+      def valid?
+        @error.nil?
+      end
+
       private
 
+      # @return [String]
+      def build_redis_url(*parts, without_namespace: false)
+        ns = without_namespace ? @namespace_prefix : namespace(*parts)
+
+        path = ?/ + [db, ns].compact.join(?/)
+
+        URI.join(@base_uri, path).to_s
+      end
+
+      def check_validity!
+        raise Savvy::RedisError, "Redis configuration is invalid: #{@error}", caller unless valid?
+      end
+
+      # @return [void]
+      def parse_url!
+        @provided_url = read_url_from_config.freeze
+
+        @parsed_url = URI.parse @provided_url
+
+        @host = @parsed_url.host
+        @port = @parsed_url.port
+
+        path_match = PATH_PATTERN.match @parsed_url.path
+
+        if path_match
+          captures =
+            if path_match.respond_to?(:named_captures)
+              path_match.named_captures
+            else
+              Hash[path_match.names.zip(path_match.captures)]
+            end
+
+          @db = Integer(captures['db'])
+
+          @namespace_prefix = captures['namespace_prefix']
+        end
+
+        @base_uri = URI::Generic.new 'redis', nil, @host, @port, nil, '', nil, nil, nil
+      rescue URI::InvalidURIError => e
+        @error = "could not parse redis URL (#{@provided_url})"
+      end
+
       def read_url_from_config
         @config.read_from_env *@config.redis_env_vars, fallback: @config.redis_default_url
       end

data/lib/savvy/error.rb

@@ -0,0 +1,5 @@
+module Savvy
+  class Error < StandardError; end
+
+  class RedisError < Error; end
+end

data/lib/savvy/version.rb

@@ -1,3 +1,3 @@
 module Savvy
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: savvy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexa Grey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cleanroom
@@ -169,6 +169,7 @@ files:
 - lib/savvy/configurators/redis.rb
 - lib/savvy/configurators/sidekiq.rb
 - lib/savvy/environment_reader.rb
+- lib/savvy/error.rb
 - lib/savvy/root_finder.rb
 - lib/savvy/templates/Savvyfile.rb.erb
 - lib/savvy/utility.rb
@@ -194,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: ENV-backed configuration helper for Redis, Sidekiq, etc