sonezaki 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cb17fab719ad3224071f4c04b777e202ccfa2f59a082e32402f08d3ac32e191
-  data.tar.gz: f7f095080b8ce32ca812000dceb749449478f5ce9188c5249de7bcce5b77a295
+  metadata.gz: 3f9c1351fab740192326bca143953adda763ba0dd7f6b26fb05317dc53d27d1b
+  data.tar.gz: e0855a20bce81102ad4de41f6d7a8535d04b0fe450d7ec400062cae9b44f2bb4
 SHA512:
-  metadata.gz: d4818ea938c0ceb178af6f6f6f0651ad50b9647caa9296d8e0a9a035bd6b513b1ecc6630b9611cc19c77493410ed2d977ad68f1952c625bce730b7b36f5f90d1
-  data.tar.gz: d43680e04886b40c319f52ed948e071521126333571941da89a84aa3ed6163334357014721d50eeb1ddc85b2289b18efc61f9dca063c2b5479871dc14f067766
+  metadata.gz: c4e4d9bd463bd3366a38a6588fe203b341f8aafdd77aa15610632b48b7ef5e78ce2d9c0593782b634aef9edfb318d6dd1fd26672505c8d8627883ec107e75fc3
+  data.tar.gz: '09807b4d59f0c0e3927b8b187ba5ed0a51ffb9d2df8f5ce1056f2b552d8e87ab045c1809f84b90093d95ddee0b39695298497506f336532dda98e02e73e47324'

data/.circleci/config.yml

@@ -18,9 +18,12 @@ workflows:
 jobs:
   test:
     docker:
-      - image: darthjee/circleci_ruby_270:1.3.0
+      - image: darthjee/circleci_ruby_331:1.0.1
         environment:
           PROJECT: sonezaki
+          REDIS_URL: redis://redis:6379/0
+      - image: circleci/redis:latest
+        name: redis
     steps:
       - checkout
       - run:
@@ -52,7 +55,7 @@ jobs:
           command: check_specs
   build-and-release:
     docker:
-      - image: darthjee/circleci_ruby_270:1.3.0
+      - image: darthjee/circleci_ruby_331:1.0.1
         environment:
           PROJECT: sonezaki
     steps:

data/.env

@@ -0,0 +1 @@
+REDIS_URL=redis://redis:6379/0

data/.rubocop.yml

@@ -2,7 +2,8 @@ require: rubocop-rspec
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.3
+  NewCops: enable
 
 Metrics/BlockLength:
   Exclude:

data/.rubocop_todo.yml

@@ -0,0 +1,15 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-05-29 22:01:31 UTC using RuboCop version 1.51.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/sonezaki/redis_accessor.rb'

data/Dockerfile

@@ -1,6 +1,6 @@
-FROM darthjee/scripts:0.3.1 as scripts
+FROM darthjee/scripts:0.4.0 as scripts
 
-FROM darthjee/ruby_270:1.3.0 as base
+FROM darthjee/ruby_331:1.0.1 as base
 
 COPY --chown=app:app ./ /home/app/app/
 

data/Gemfile

@@ -3,3 +3,21 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'bundler',            '>= 2.5.11'
+gem 'pry',                '0.14.2'
+gem 'pry-nav',            '1.0.0'
+gem 'rake',               '13.1.0'
+gem 'redis',              '5.2.0'
+gem 'reek',               '6.1.4'
+gem 'rspec',              '3.12.0'
+gem 'rspec-core',         '3.12.2'
+gem 'rspec-expectations', '3.12.3'
+gem 'rspec-mocks',        '3.12.5'
+gem 'rspec-support',      '3.12.0'
+gem 'rubocop',            '1.59.0'
+gem 'rubocop-rspec',      '2.29.2'
+gem 'rubycritic',         '4.9.1'
+gem 'simplecov',          '0.22.0'
+gem 'yard',               '0.9.36'
+gem 'yardstick',          '0.9.9'

data/README.md

@@ -8,7 +8,7 @@ Sonezaki
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/9836de08612e46b889c7978be2b72a14)](https://www.codacy.com/manual/darthjee/sonezaki?utm_source=github.com&utm_medium=referral&utm_content=darthjee/sonezaki&utm_campaign=Badge_Grade)
 [![Inline docs](http://inch-ci.org/github/darthjee/sonezaki.svg?branch=master)](http://inch-ci.org/github/darthjee/sonezaki)
 
-![sonezaki](https://raw.githubusercontent.com/darthjee/sonezaki/master/sonezaki.jpg)
+![sonezaki](https://raw.githubusercontent.com/darthjee/sonezaki/master/sonezaki.png)
 
 Gem used for storing and accessing data during debugging sessions
 

data/config/check_specs.yml

@@ -1,2 +1,2 @@
 ignore:
-  - lib/stalchild/version.rb
+  - lib/sonezaki/version.rb

data/config/yardstick.yml

@@ -15,13 +15,15 @@ rules:
     exclude: []
   ExampleTag:
     enabled: true
-    exclude: []
+    exclude:
+      - Sonezaki::RedisAccessor#initialize
   ReturnTag:
     enabled: true
     exclude: []
   Summary::Presence:
     enabled: true
-    exclude: []
+    exclude:
+      - Sonezaki::RedisAccessor#initialize
   Summary::Length:
     enabled: true
     exclude: []

data/docker-compose.yml

@@ -1,10 +1,16 @@
 version: '3'
 services:
+  sonezaki_redis:
+    image: redis:6.2.4
+    container_name: sonezaki_redis
+
   base: &base
     image: sonezaki
     working_dir: /home/app/app
     volumes:
       - .:/home/app/app
+    links:
+      - sonezaki_redis:redis
 
   base_build:
     <<: *base
@@ -16,6 +22,7 @@ services:
     container_name: sonezaki
     depends_on: [base_build]
     command: /bin/bash -c 'rspec'
+    env_file: .env
 
   test_all:
     <<: *base

data/lib/sonezaki/redis_accessor.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Sonezaki
+  # @api public
+  # @author darthjee
+  #
+  # Accessor that readis and write values into Redis
+  #
+  # @example Simple usage
+  #   accessor = Sonezaki::RedisAccessor.new('my_key', type: :integer)
+  #
+  #   accessor.set('10.1')
+  #
+  #   accessor.get # returns 10
+  class RedisAccessor
+    MONTH = 30 * 24 * 3600
+
+    # @param key [Symbol,String] Key used to save the data on redis
+    # @param type [Symbol] Type of convertion when retrieving the data
+    # @param ttl [Integer] Seconds the data will exist before expiration
+    def initialize(key, type: :string, ttl: MONTH)
+      @key = key
+      @type = type
+      @ttl = ttl
+    end
+
+    # Save the value into redis
+    #
+    # @param value [Object] Object to be saved
+    #
+    # Saving will convert the value as string
+    #
+    # @return [Object] the value itself as it is read from Redis
+    #
+    # @example (see RedisAccessor)
+    def set(value)
+      options = { ex: ttl }.compact
+      connection.set(key, value, **options)
+      get
+    end
+
+    # Fetch the value from redis
+    #
+    # The value is converted using {#type}
+    #
+    # @return [Object]
+    #
+    # @example (see RedisAccessor)
+    def get
+      value = connection.get(key)
+      return unless value
+      return value unless type
+
+      convert(value)
+    end
+
+    private
+
+    attr_reader :key, :type, :ttl
+
+    # @method key
+    # @private
+    # @api private
+    #
+    # Retrieve saving / reading key
+    #
+    # @return [Symbol, String]
+
+    # @method type
+    # @private
+    # @api private
+    #
+    # Type conversion when reading data
+    #
+    # @return [Symbol]
+
+    # @method ttl
+    # @private
+    # @api private
+    #
+    # Time until the value expires in Redis
+    #
+    # @return [Integer]
+
+    # @private
+    # @api private
+    #
+    # Convert the string read from Redis
+    #
+    # The value will be converted using {#type}
+    #
+    # @param value [String] The value read from redis
+    #
+    # @return [Object]
+    def convert(value)
+      case type
+      when :integer
+        return value.to_i
+      when :float
+        return value.to_f
+      end
+      value
+    end
+
+    # @private
+    # @api private
+    #
+    # Connection to redis
+    #
+    # @return [Redis]
+    def connection
+      @connection ||= build_connection
+    end
+
+    # @private
+    # @api private
+    #
+    # builds the connection to redis
+    #
+    # When this method is called is when redis is required.
+    #
+    # This is done so that projects can choose which accessor
+    # they want insted of use always Reds
+    #
+    # @return [Redis]
+    def build_connection
+      require 'redis'
+
+      Redis.new
+    end
+  end
+end

data/lib/sonezaki/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-class Sonezaki
-  VERSION = '0.0.0'
+module Sonezaki
+  VERSION = '0.0.1'
 end

data/lib/sonezaki.rb

@@ -2,6 +2,7 @@
 
 # @api public
 # @author darthjee
-class Sonezaki
+module Sonezaki
   autoload :VERSION, 'sonezaki/version'
+  autoload :RedisAccessor, 'sonezaki/redis_accessor'
 end

data/sonezaki.gemspec

@@ -12,27 +12,11 @@ Gem::Specification.new do |gem|
   gem.homepage              = 'https://github.com/darthjee/sonezaki'
   gem.description           = ''
   gem.summary               = gem.description
-  gem.required_ruby_version = '>= 2.7.0'
+  gem.required_ruby_version = '>= 3.3.0'
 
   gem.files                 = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables           = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  gem.test_files            = gem.files.grep(%r{^(test|gem|features)/})
   gem.require_paths         = ['lib']
 
-  gem.add_development_dependency 'bundler',            '2.4.8'
-  gem.add_development_dependency 'pry',                '0.14.1'
-  gem.add_development_dependency 'pry-nav',            '1.0.0'
-  gem.add_development_dependency 'rake',               '13.0.6'
-  gem.add_development_dependency 'reek',               '6.0.3'
-  gem.add_development_dependency 'rspec',              '3.11.0'
-  gem.add_development_dependency 'rspec-core',         '3.11.0'
-  gem.add_development_dependency 'rspec-expectations', '3.11.0'
-  gem.add_development_dependency 'rspec-mocks',        '3.11.1'
-  gem.add_development_dependency 'rspec-support',      '3.11.0'
-  gem.add_development_dependency 'rubocop',            '0.80.1'
-  gem.add_development_dependency 'rubocop-rspec',      '1.38.1'
-  gem.add_development_dependency 'rubycritic',         '4.7.0'
-  gem.add_development_dependency 'simplecov',          '0.21.2'
-  gem.add_development_dependency 'yard',               '0.9.27'
-  gem.add_development_dependency 'yardstick',          '0.9.9'
+  gem.metadata['rubygems_mfa_required'] = 'true'
 end

data/spec/integration/yard/sonezaki/redis_accessor_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sonezaki::RedisAccessor do
+  describe 'yard' do
+    it 'Simple usage' do
+      accessor = Sonezaki::RedisAccessor.new('my_key', type: :integer)
+
+      accessor.set('10.1')
+
+      expect(accessor.get).to eq(10)
+    end
+  end
+end

data/spec/lib/sonezaki/redis_accessor_spec.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sonezaki::RedisAccessor do
+  subject(:accessor) do
+    described_class.new(key, **options)
+  end
+
+  let(:key) do
+    "SomeKey_#{Random.rand(1000)}"
+  end
+
+  let(:options) { {} }
+
+  after do
+    Redis.new.del(key)
+  end
+
+  describe '#get' do
+    context 'when nothing has been set' do
+      it do
+        expect(accessor.get).to be_nil
+      end
+    end
+
+    context 'when a value has been set' do
+      let(:value) { Random.rand(1_000_000) / 100.0 }
+
+      before do
+        Redis.new.set(key, value)
+      end
+
+      context 'when type option is not given' do
+        it 'returns the string for the value' do
+          expect(accessor.get).to eq(value.to_s)
+        end
+      end
+
+      context 'when type option is integer' do
+        let(:options) { { type: :integer } }
+
+        it 'returns the integer for the value' do
+          expect(accessor.get).to eq(value.to_i)
+        end
+      end
+
+      context 'when type option is float' do
+        let(:options) { { type: :float } }
+
+        it 'returns the float for the value' do
+          expect(accessor.get).to eq(value)
+        end
+      end
+    end
+  end
+
+  describe '#set' do
+    let(:value) { Random.rand(100_000) / 10.0 }
+
+    context 'when type has not been defined' do
+      it 'returns the stored value' do
+        expect(accessor.set(value)).to eq(value.to_s)
+      end
+
+      it 'stores the value for future reading' do
+        expect { accessor.set(value) }
+          .to change(accessor, :get)
+          .from(nil)
+          .to(value.to_s)
+      end
+
+      it 'stores the value in redis' do
+        expect { accessor.set(value) }
+          .to change { Redis.new.get(key) }
+          .from(nil)
+          .to(value.to_s)
+      end
+    end
+
+    context 'when type has been defined as integer' do
+      let(:options) { { type: :integer } }
+
+      it 'returns the stored value' do
+        expect(accessor.set(value)).to eq(value.to_i)
+      end
+
+      it 'stores the value for future reading' do
+        expect { accessor.set(value) }
+          .to change(accessor, :get)
+          .from(nil)
+          .to(value.to_i)
+      end
+
+      it 'stores the value in redis' do
+        expect { accessor.set(value) }
+          .to change { Redis.new.get(key) }
+          .from(nil)
+          .to(value.to_s)
+      end
+    end
+  end
+end

data/spec/lib/sonezaki_spec.rb

@@ -3,6 +3,5 @@
 require 'spec_helper'
 
 describe Sonezaki do
-  it 'does something' do
-  end
+  xit 'does something'
 end

data/spec/spec_helper.rb

@@ -10,10 +10,11 @@ SimpleCov.start 'gem'
 
 require 'sonezaki'
 require 'pry-nav'
+require 'redis'
 
 support_files = File.expand_path('spec/support/**/*.rb')
 
-Dir[support_files].sort.each { |file| require file }
+Dir[support_files].each { |file| require file }
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true

metadata

@@ -1,239 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sonezaki
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-25 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.4.8
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.4.8
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.14.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.14.1
-- !ruby/object:Gem::Dependency
-  name: pry-nav
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 6.0.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 6.0.3
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-- !ruby/object:Gem::Dependency
-  name: rspec-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-- !ruby/object:Gem::Dependency
-  name: rspec-expectations
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-- !ruby/object:Gem::Dependency
-  name: rspec-mocks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.11.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.11.1
-- !ruby/object:Gem::Dependency
-  name: rspec-support
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.80.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.80.1
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.38.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.38.1
-- !ruby/object:Gem::Dependency
-  name: rubycritic
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.7.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.7.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.21.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.21.2
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.27
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.27
-- !ruby/object:Gem::Dependency
-  name: yardstick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.9
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.9.9
+date: 2024-05-30 00:00:00.000000000 Z
+dependencies: []
 description: ''
 email:
 - darthjee@gmail.com
@@ -242,6 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".env"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -257,18 +34,22 @@ files:
 - config/yardstick.yml
 - docker-compose.yml
 - lib/sonezaki.rb
+- lib/sonezaki/redis_accessor.rb
 - lib/sonezaki/version.rb
 - sonezaki.gemspec
 - sonezaki.png
 - spec/integration/readme/.keep
 - spec/integration/yard/.keep
+- spec/integration/yard/sonezaki/redis_accessor_spec.rb
+- spec/lib/sonezaki/redis_accessor_spec.rb
 - spec/lib/sonezaki_spec.rb
 - spec/spec_helper.rb
 - spec/support/models/.keep
 - spec/support/shared_examples/.keep
 homepage: https://github.com/darthjee/sonezaki
 licenses: []
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -277,14 +58,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: ''