key-vortex 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2168a75a039ac6c30df6169b07bf336972ed590183198ce6af1dc201466fd681
-  data.tar.gz: 81c5b8f8106043999de4e654e486b617cb4ec128885f59e570af1f2725f18518
+  metadata.gz: 1039a71bf775b3754d1ae275c5d70b39921cb4e390e39158ab4b6cde49fed5c8
+  data.tar.gz: fa53fb6bd5aeca2c436b162e0c4bb37e7571de24eb279f334790bb239dc00c63
 SHA512:
-  metadata.gz: 7785c206cd17cbb96463a9f9132942c62cce8524915e9031ea9aaf1f5b8015568799de95a8eda82e7db4452cc358a652e37dfebff2e6d5006b8b4acd40d098f1
-  data.tar.gz: 70dce040a5c57932fd52d5a90b57542b00d7b9054f573869e1e03e1e8f0dc2c81fb74dce6fad2abf676a47623b592b869615dbbe8b678a36ca4bc7557442ae76
+  metadata.gz: 9b00849471bfd401f4db7ca3ce46ca5a1e47665b94c8d2f29eacba3ff55fb7174058629d82c61034c9eb6f820ee4f89be369e75249fd3f0f764d870a2071dbb2
+  data.tar.gz: 2ff852525522a69fb833cea7acce7737687f9aa353c9f6c83a23d8abd62ec0dcf2bc1019a94d0a74f0f6f329d2cee3fc90be59636822646d74e5fac0de918110

data/.reek.yml

@@ -0,0 +1,4 @@
+detectors:
+  # TODO: Remove once design is set
+  IrresponsibleModule:
+    enabled: false

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: enable
 
 Style/StringLiterals:
   Enabled: true
@@ -11,3 +12,7 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+# TODO: Remove once design is set
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -7,6 +7,16 @@ gemspec
 
 gem "rake", "~> 13.0"
 
+gem "reek", "~> 6.1.4"
 gem "rspec", "~> 3.0"
-
 gem "rubocop", "~> 1.21"
+
+gem "guard"
+gem "guard-reek"
+gem "guard-rspec"
+gem "guard-rubocop"
+
+gem "byebug"
+gem "stashify-contract"
+
+gem "yard"

data/Gemfile.lock

@@ -0,0 +1,116 @@
+PATH
+  remote: .
+  specs:
+    key-vortex (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-reek (1.2.0)
+      guard-compat (~> 1.1)
+      reek
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.5.0)
+      guard (~> 2.0)
+      rubocop (< 2.0)
+    json (2.6.3)
+    kwalify (0.7.2)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rantly (2.0.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    reek (6.1.4)
+      kwalify (~> 0.7.0)
+      parser (~> 3.2.0)
+      rainbow (>= 2.0, < 4.0)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.49.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    shellany (0.0.1)
+    stashify-contract (1.0.1)
+      rantly (~> 2.0.0)
+      rspec (~> 3.0)
+    thor (1.2.2)
+    unicode-display_width (2.4.2)
+    yard (0.9.34)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  guard
+  guard-reek
+  guard-rspec
+  guard-rubocop
+  key-vortex!
+  rake (~> 13.0)
+  reek (~> 6.1.4)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  stashify-contract
+  yard
+
+BUNDLED WITH
+   2.2.33

data/Guardfile

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: "bundle exec rspec", all_on_pass: true do
+    require "guard/rspec/dsl"
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # Feel free to open issues for suggestions and improvements
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard :rubocop, cli: "--autocorrect-all --display-cop-names" do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
+
+  guard "reek" do
+    watch(/.+\.rb$/)
+    watch(".reek.yml")
+  end
+end

data/key-vortex.gemspec

@@ -9,7 +9,8 @@ Gem::Specification.new do |spec|
   spec.email = ["lambda.null.42@gmail.com"]
 
   spec.summary = "Abstraction for interacting with various record stores"
-  spec.description = "Defines abstractions that can be built on top of for key/value storage on different technologies (file, s3, sql, redis, etc.)"
+  spec.description = "Defines abstractions that can be built on top of for key/value " \
+                     "storage on different technologies (file, s3, sql, redis, etc.)"
   spec.homepage = "https://github.com/Lambda-Null/key-vortex"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
@@ -33,4 +34,5 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/key_vortex/memory.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class KeyVortex
+  class Memory
+    def initialize(items)
+      @items = items
+    end
+
+    def set(key, item)
+      @items[key] = item
+    end
+
+    def get(key)
+      @items[key]
+    end
+
+    def remove(key)
+      @items.delete(key)
+    end
+  end
+end

data/lib/key_vortex/record/string.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class KeyVortex
+  class Record
+    class String
+      def initialize(value)
+        @value = value
+      end
+    end
+  end
+end

data/lib/key_vortex/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module KeyVortex
-  VERSION = "0.1.0"
+class KeyVortex
+  VERSION = "0.1.1"
 end

data/lib/key_vortex.rb

@@ -2,7 +2,7 @@
 
 require_relative "key_vortex/version"
 
-module KeyVortex
+class KeyVortex
   class Error < StandardError; end
   # Your code goes here...
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: key-vortex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Lambda Null
@@ -18,10 +18,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -29,6 +32,8 @@ files:
 - bin/setup
 - key-vortex.gemspec
 - lib/key_vortex.rb
+- lib/key_vortex/memory.rb
+- lib/key_vortex/record/string.rb
 - lib/key_vortex/version.rb
 - sig/record/store.rbs
 homepage: https://github.com/Lambda-Null/key-vortex
@@ -37,6 +42,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Lambda-Null/key-vortex
   source_code_uri: https://github.com/Lambda-Null/key-vortex
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: