sideroo 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03a7b294f185dedea2a5a2b24280df69d4102e54bdaf729819b4823205e7057c
-  data.tar.gz: 654bca601be4cc8481d5be43410b96f3bf7029b3212828d89d183b593d9acd7d
+  metadata.gz: c03495a873770c5d552eb9c0ef4101f747f6e1783372eb9bd66c16c5bb407402
+  data.tar.gz: d75ddcb78b2604d202227557dc67fdbe32f5002da340e6c2dbfce31bf19adf12
 SHA512:
-  metadata.gz: 19dafd77261755bfc811c4520f299b5b895ac4daaf2c4016e5d0172f794369c9a5574b397aa294dcf8420bea03fed7e6ee9f0b797a40828accb896fb52a6566c
-  data.tar.gz: 592e26ba47f3e4547b7e57a4353c4d13b44158d1904fe09635d178b94f7ea41c200747e5d42faa1a3ea8dc0a95b2b92bd2a1adb4d2418d8355188b118a59afe1
+  metadata.gz: a2e61addab0caf170ee6f1ab5e064499565995c855777d1dcf2fe75ea11e40b925bd2ef978aeb2aaa1d7c31ffa9ee3236ac7f881d6cd6200e6655c880230d41a
+  data.tar.gz: 58441f5659b2bf72dca1289f538966a933793f7d9b2da0c4f2509a2d06d51324bfcf3a46c06df38d49cd33d46c39b4e36b3abddb25f78d36f476330755078601

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sideroo (1.1.0)
+    sideroo (1.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -15,11 +15,16 @@ This gem is aimed to provide
     example 'top_stories:us:romance'
     key_regex /^top_stories\:(\w{2})\:([^\:]+)$/ # OPTIONAL - read docs below
   end
+
+  TopStoriesCache.dimensions # ['country', 'category']
   ```
-- an **intuitive** Redis key initialization
+- an **intuitive** Redis key initialization & `attr_accessor`
   ```rb
   cache = TopStoriesCache.new(country: 'us', category: 'romance')
   # instead of repeating key = "top_stories:#{country}:#{category}"
+
+  cache.country # us
+  cache.genre # romance
   ```
 - **object-oriented** methods for each Redis data type
   ```rb
@@ -566,22 +571,42 @@ cache = UserStoriesCache.new(...)
 cache.use_client(instance_redis_client)
 ```
 
+## 7. Advanced usages
+
+### 7.1. Dimension validations
+
+To keep this gem thin, we have decided not to add explicit support for dimension validation.
+
+However, `Sideroo` collaborates perfectly with `ActiveModel::Validations`. Please incorporate at your own needs.
+
+```rb
+class TopStoriesCache < Sideroo::Set
+  include ActiveModel::Validations
+
+  key_pattern 'top_stories:{country}:{category}'
+  description 'Cache top stories by ID per country and category'
+  example 'top_stories:us:romance'
+
+  validates :country, length: 2
+  validates :category, regex: /^[^:]+$/
+end
+```
 
-## 7. Development
+## 8. Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## 8. Contributing
+## 9. Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sideroo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sideroo/blob/master/CODE_OF_CONDUCT.md).
 
 
-## 9. License
+## 10. License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## 10. Code of Conduct
+## 11. Code of Conduct
 
 Everyone interacting in the Sideroo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sideroo/blob/master/CODE_OF_CONDUCT.md).

data/lib/sideroo.rb

@@ -1,6 +1,5 @@
 require "sideroo/version"
 require "sideroo/enumerator"
-require "sideroo/key_builder"
 require "sideroo/types/base"
 require "sideroo/types/bitmap"
 require "sideroo/types/hash"
@@ -14,6 +13,10 @@ module Sideroo
   class Error < StandardError; end
   class MissingKeys < ArgumentError; end
   class UnexpectedKeys < ArgumentError; end
+  class InvalidExample < StandardError; end
+  class InvalidKeyRegex < StandardError; end
+  class OutOfOrderConfig < StandardError; end
+  class PatternAlreadyDeclared < StandardError; end
 
   class Configuration
     attr_accessor :redis_client

data/lib/sideroo/types/base.rb

@@ -15,19 +15,29 @@ module Sideroo
       end
 
       def key_pattern(*args)
-        @key_pattern = args.first if args.count > 0
+        if args.count > 0
+          declare_key_pattern(args.first)
+        end
+
         @key_pattern
       end
 
       def key_regex(*args)
-        @key_regex = args.first if args.count > 0
+        if args.count > 0
+          custom_key_regex_should_be_defined_before_example!
+          @key_regex = args.first
+        end
         @key_regex || default_key_regex
       end
 
-      ## METADATA
+      # Provide example to test against key_pattern and key_regex.
+      # Strongly recommended. Please watch out for edge cases.
       #
       def example(*args)
-        @example = args.first if args.count > 0
+        if args.count > 0
+          @example = args.first
+          validate_example_and_regex!
+        end
         @example
       end
 
@@ -37,9 +47,12 @@ module Sideroo
       end
 
       def key_attributes
-        KeyBuilder.key_attributes(key_pattern)
+        regex = /\{([^\{\}]+)\}/
+        key_pattern.scan(regex).map(&:first)
       end
 
+      alias_method :dimensions, :key_attributes
+
       def redis_client(*args)
         @redis_client = args.first if args.count > 0
         @redis_client || Sideroo.redis_client
@@ -66,11 +79,19 @@ module Sideroo
         all.each(&:del)
       end
 
-      def example_valid?
-        example.nil? || example =~ key_regex
+      private
+
+      def declare_key_pattern(pattern)
+        raise Sideroo::PatternAlreadyDeclared unless key_pattern.nil?
+        @key_pattern = pattern
+        define_dimensions_as_attr_accessors
       end
 
-      private
+      def define_dimensions_as_attr_accessors
+        dimensions.each do |dimension|
+          attr_accessor dimension
+        end
+      end
 
       def define_redis_method(method_name)
         define_method method_name do |*args|
@@ -91,6 +112,31 @@ module Sideroo
 
         Regexp.new("^#{regex_str}$")
       end
+
+      def custom_key_regex_should_be_defined_before_example!
+        return if example.nil?
+        message = 'Custom key regex should be defined before example'
+        raise Sideroo::OutOfOrderConfig, message
+      end
+
+      # Validate if the provided example matches key regex
+      #
+      def validate_example_and_regex!
+        return if example.nil?
+        example_valid = example =~ key_regex
+
+        unless example_valid
+          message = "Example does not match key regex: #{key_regex}"
+          raise Sideroo::InvalidExample, message
+        end
+
+        values = example.scan(key_regex).first
+
+        if values.count != dimensions.count
+          message = "Expected #{dimensions.count} dimensions, got #{values.count}"
+          raise Sideroo::InvalidKeyRegex, message
+        end
+      end
     end
 
     # Methods applied to all types
@@ -113,25 +159,40 @@ module Sideroo
       unlink
     ]
 
-    attr_reader :key
-
     def initialize(arg = {})
-      @key =
-        case arg
-        when ::String
-          message = "Expected pattern #{self.class.key_pattern}, got #{arg}"
-          raise(ArgumentError, message) if arg !~ self.class.key_regex
-          arg
-        when ::Hash
-          attr_map = arg
-          KeyBuilder.new(
-            attr_map: attr_map,
-            key_pattern: self.class.key_pattern,
-          ).build
-        else
-          message = "Hash or String expected. #{arg.class} given."
-          raise ArgumentError, message
+      case arg
+      when ::String
+        raw_key = arg
+        key_regex = self.class.key_regex
+
+        message = "Expected pattern #{key_pattern}, got #{arg}"
+        raise(ArgumentError, message) if raw_key !~ key_regex
+
+        values = raw_key.scan(key_regex).first
+        self.class.dimensions.zip(values).each do |dimension, value|
+          send("#{dimension}=", value)
         end
+      when ::Hash
+        attr_map = arg
+        attr_map.each do |dimension, value|
+          send("#{dimension}=", value)
+        end
+      else
+        message = "Hash or String expected. #{arg.class} given."
+        raise ArgumentError, message
+      end
+    end
+
+    def key
+      k = key_pattern
+
+      self.class.dimensions.each do |dimension|
+        term = "{#{dimension}}"
+        value = send(dimension)
+        k = k.gsub(term, value.to_s)
+      end
+
+      k
     end
 
     def redis_client=(client)
@@ -141,5 +202,29 @@ module Sideroo
     def redis_client
       @redis_client || self.class.redis_client
     end
+
+    private
+
+    def key_pattern
+      self.class.key_pattern
+    end
+
+    def validate_attrs!(attr_map)
+      provided_attrs = attr_map.keys.map(&:to_s)
+      key_attributes = self.class.key_attributes(key_pattern)
+
+      missing_attrs = key_attributes - provided_attrs
+      unexpected_attrs = provided_attrs - key_attributes
+
+      if missing_attrs.any?
+        msg = "Missing attributes: #{missing_attrs.join(', ')}"
+        raise MissingKeys, msg
+      end
+
+      if unexpected_attrs.any?
+        msg = "Unexpected attributes: #{unexpected_attrs.join(', ')}"
+        raise UnexpectedKeys, msg
+      end
+    end
   end
 end

data/lib/sideroo/version.rb

@@ -1,3 +1,3 @@
 module Sideroo
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/sideroo.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/ntd251/sideroo"
-  spec.metadata["changelog_uri"] = "https://github.com/ntd251/sideroo"
+  spec.metadata["changelog_uri"] = "https://github.com/ntd251/sideroo/releases"
+  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/github/ntd251/sideroo"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sideroo
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Duong Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-19 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies: []
 description: "\n    Provide a declarative Redis key definition, intuitive key initialization,
   object-oriented methods for Redis data type, and auditable Redis key management.\n
@@ -32,7 +32,6 @@ files:
 - bin/setup
 - lib/sideroo.rb
 - lib/sideroo/enumerator.rb
-- lib/sideroo/key_builder.rb
 - lib/sideroo/types/base.rb
 - lib/sideroo/types/bitmap.rb
 - lib/sideroo/types/hash.rb
@@ -50,7 +49,8 @@ metadata:
   allowed_push_host: https://rubygems.org/
   homepage_uri: https://github.com/ntd251/sideroo
   source_code_uri: https://github.com/ntd251/sideroo
-  changelog_uri: https://github.com/ntd251/sideroo
+  changelog_uri: https://github.com/ntd251/sideroo/releases
+  documentation_uri: https://www.rubydoc.info/github/ntd251/sideroo
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/sideroo/key_builder.rb

@@ -1,53 +0,0 @@
-module Sideroo
-  class KeyBuilder
-    attr_reader :attr_map
-    attr_reader :key_pattern
-
-    class << self
-      def key_attributes(key_pattern)
-        regex = /\{([^\{\}]+)\}/
-        key_pattern.scan(regex).map(&:first)
-      end
-    end
-
-    def initialize(attr_map:, key_pattern:)
-      @attr_map = attr_map
-      @key_pattern = key_pattern
-    end
-
-    def build
-      validate_attrs!
-      populate_key
-    end
-
-    private
-
-    def validate_attrs!
-      provided_attrs = attr_map.keys.map(&:to_s)
-      key_attributes = self.class.key_attributes(key_pattern)
-
-      missing_attrs = key_attributes - provided_attrs
-      unexpected_attrs = provided_attrs - key_attributes
-
-      if missing_attrs.any?
-        msg = "Missing attributes: #{missing_attrs.join(', ')}"
-        raise MissingKeys, msg
-      end
-
-      if unexpected_attrs.any?
-        msg = "Unexpected attributes: #{unexpected_attrs.join(', ')}"
-        raise UnexpectedKeys, msg
-      end
-    end
-
-    def populate_key
-      key = key_pattern
-      attr_map.each do |attr, value|
-        term = "{#{attr}}"
-        key = key.gsub(term, value.to_s)
-      end
-
-      key
-    end
-  end
-end