skeevy 0.0.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56219e553136787ef81221e9d1c30198ce3c456e
-  data.tar.gz: 41318a6e7228958f487258630c11373930523a59
+  metadata.gz: 708fca8af138d7576b3bea4151c4d8e6ba68ff34
+  data.tar.gz: d8e76988b05d3750e8c10825f6afc4a954ac83b2
 SHA512:
-  metadata.gz: 8de217cf5b58469ee7bea8f55653d23da85184e017a0b320e30419c6d78fd63f9b6b9f3e866b4b31642b7fd66c3a0badc7fe9b9e7ba52600d19ab5dcf3d6a191
-  data.tar.gz: 7509329ca813f8ec828d18cb4bfa32719cba9b184c508ae97534d0d2e9651e2afb8e90acf5fa8b2db8d3e1ab1403d532f9ec879a8c009635d76a25b1b238ff94
+  metadata.gz: 5ec8aff61eb16ba1fc9abe0ff3d4bf93235f606afd02b7fac24c1524b2bb1f4c2e986422fdd3aa9ad2a791a464b8a66f086237b2a005f0fdb11c0da7e069a28c
+  data.tar.gz: 2612ff0d14ee9ebb86eba73ce2dd7bfcdf44030a665f6d6f9a97a2622fc704d2fe1be78ade77b4a3c68c282e86f7e61c422dfe6f24fe09cc2315c156aa029054

data/lib/skeevy.rb

@@ -4,6 +4,9 @@ require 'skeevy/cutter'
 require 'skeevy/cutters/standard_key'
 require 'skeevy/engines/symbolic_hash'
 require 'skeevy/engines/directory_file'
+require 'skeevy/filter'
+require 'skeevy/filters/rot_13'
+require 'skeevy/filters/zlib_compression'
 require 'skeevy/instance'
 
 fail "Skeevy #{Skeevy::VERSION} requires Ruby 2.1 or later." if RUBY_VERSION < '2.1.0'
@@ -12,12 +15,13 @@ module Skeevy
 
   # Poor-man's singleton
   class << self
-    def register!(identifier:, engine: nil, cutter: nil)
+    def register!(identifier:, engine: nil, cutter: nil, filters: nil)
       raise(ArgumentError, "Identifier must be a symbol") unless identifier.is_a?(Symbol)
       @instances ||= {}
       @instances[identifier] = Instance.new identifier: identifier,
                                        engine: engine,
-                                       cutter: cutter
+                                       cutter: cutter,
+                                       filters: filters || []
     end
 
     def instance(identifier)

data/lib/skeevy/engine.rb

@@ -18,5 +18,9 @@ module Skeevy
     def delete!(key:)
       raise NoMethodError, "Your Engine is missing .delete!"
     end
+
+    def keys
+      raise NoMethodError, "Your Engine is missing .keys"
+    end
   end
 end

data/lib/skeevy/engines/directory_file.rb

@@ -35,9 +35,7 @@ module Skeevy
       def read(key:)
         path = path_for(key: key)
         if exist?(path: path, key: nil)
-          File.open(path, "r:#{@encoding}") { |f|
-            f.read
-          }
+          IO.binread(path)
         else
           nil
         end
@@ -45,9 +43,7 @@ module Skeevy
 
       def write!(key:, content:)
         path = path_for(key: key)
-        File.open(path, "w:#{@encoding}") { |f|
-          f.write content
-        }
+        IO.binwrite(path, content)
       end
 
       def delete!(key:)
@@ -59,6 +55,12 @@ module Skeevy
         false
       end
 
+      def keys
+        @files = []
+        check_directory(dir: "#{@base_dir}/*")
+        @files
+      end
+
       private
 
       def ensure_exists(path:)
@@ -69,6 +71,16 @@ module Skeevy
       def ensure_base_dir_exists
         ensure_exists(path: @base_dir)
       end
+
+      def check_directory(dir:, prefix: '')
+        Dir.glob(dir).each do |f|
+          if(File.directory? f)
+            check_directory(dir: "#{f}/*", prefix: f)
+          else
+            @files << f.gsub("#{@base_dir}/", '').gsub('/', @delimiter)
+          end
+        end
+      end
     end
   end
 end

data/lib/skeevy/engines/symbolic_hash.rb

@@ -32,6 +32,9 @@ module Skeevy
         false
       end
 
+      def keys
+        @items.keys.map(&:to_s)
+      end
     end
   end
 end

data/lib/skeevy/filter.rb

@@ -0,0 +1,11 @@
+module Skeevy
+  module Filter
+    def filter_write(content: )
+      raise NoMethodError, "Your Filter is missing .filter_write"
+    end
+
+    def filter_read(content: )
+      raise NoMethodError, "Your Filter is missing filter_read"
+    end
+  end
+end

data/lib/skeevy/filters/rot_13.rb

@@ -0,0 +1,16 @@
+module Skeevy
+  module Filters
+    class Rot13
+      include Skeevy::Filters
+
+      def filter_write(content:)
+        content.tr!("abcdefghijklmnopqrstuvwxyz",
+                  "nopqrstuvwxyzabcdefghijklm")
+      end
+
+      def filter_read(content:)
+        filter_write(content: content)
+      end
+    end
+  end
+end

data/lib/skeevy/filters/zlib_compression.rb

@@ -0,0 +1,17 @@
+module Skeevy
+  module Filters
+    class ZlibCompression
+      include Skeevy::Filters
+      require 'zlib'
+
+      def filter_write(content:)
+        Zlib.deflate(content)
+      end
+
+      def filter_read(content:)
+        Zlib.inflate(content)
+      end
+    end
+  end
+end
+

data/lib/skeevy/instance.rb

@@ -5,12 +5,16 @@ module Skeevy
 
     def initialize(identifier:,
                    engine: nil,
-                   cutter: nil)
+                   cutter: nil,
+                   filters: []
+    )
       raise(ArgumentError, "identifier must be a Symbol") unless identifier.is_a?(Symbol)
       raise(ArgumentError, "engine #{engine} is not a Skeevy Engine!") unless engine.is_a?(Skeevy::Engine) || engine.nil?
       raise(ArgumentError, "cutter #{cutter} is not a Skeevy Cutter!") unless cutter.is_a?(Skeevy::Cutter) || cutter.nil?
+      raise(ArgumentError, "filters must be an array") unless filters.is_a?(Array)
       @cutter = cutter || Skeevy::Cutters::StandardKey.new(instance: self)
       @engine = engine || Skeevy::Engines::SymbolicHash.new(instance: self)
+      @filters = filters
       @cutter.instance ||= self
       @engine.instance ||= self
       @identifier = identifier
@@ -25,10 +29,17 @@ module Skeevy
     end
 
     def read(key:)
-      @engine.read(key: key)
+      content = @engine.read(key: key)
+      @filters.reverse.each do |f|
+        content = f.filter_read(content: content)
+      end
+      content
     end
 
     def write!(key:, content:)
+      @filters.each do |f|
+        content = f.filter_write(content: content)
+      end
       @engine.write!(key: key, content: content)
     end
 
@@ -44,5 +55,8 @@ module Skeevy
       { identifier: @identifier, engine: @engine, cutter: @cutter}.to_s
     end
 
+    def add_filter(filter:)
+      @filters << filter
+    end
   end
 end

data/lib/skeevy/version.rb

@@ -1,3 +1,3 @@
 module Skeevy
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/skeevy.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'skeevy'
-  s.version     = '0.0.2'
-  s.date        = '2014-12-30'
+  s.version     = '1.0.1'
+  s.date        = '2015-02-13'
   s.summary     = "Skeevy"
   s.description = "A simple key-value store for objects"
   s.authors     = ["Craig Waterman"]
@@ -15,5 +15,5 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_development_dependency 'rspec',   '~> 3.1'
-  s.add_development_dependency 'guard-rspec', '~> 4.4.2'
-end
+  s.add_development_dependency 'guard-rspec', '~> 4.4'
+end

data/spec/lib/skeevy/filters/rot_13_spec.rb

@@ -0,0 +1,15 @@
+RSpec.describe :rot_13 do
+  let(:filter) { Skeevy::Filters::Rot13.new }
+
+  describe '#filter_write' do
+    it 'performs a rot13 translation on the content' do
+      expect(filter.filter_write(content: 'testing')).to eq 'grfgvat'
+    end
+  end
+
+  describe '#filter_read' do
+    it 'performs a reverse rot13 (same as rot13) on the content' do
+      expect(filter.filter_write(content: 'grfgvat')).to eq 'testing'
+    end
+  end
+end

data/spec/lib/skeevy/filters/zlib_compression_spec.rb

@@ -0,0 +1,15 @@
+RSpec.describe :zlib_compression do
+  let(:filter) { Skeevy::Filters::ZlibCompression.new }
+
+  describe '#filter_write' do
+    it 'zlib deflates the content' do
+      expect(filter.filter_write(content: 'testing')).to eq Zlib.deflate('testing')
+    end
+  end
+
+  describe '#filter_read' do
+    it 'zlib inflates the content' do
+      expect(filter.filter_read(content: Zlib.deflate('testing'))).to eq 'testing'
+    end
+  end
+end

data/spec/lib/skeevy/instance_spec.rb

@@ -46,4 +46,23 @@ RSpec.describe :instance do
     end
   end
 
+  describe '#add_filter' do
+    let(:filter_rot13) { Skeevy::Filters::Rot13.new }
+    let(:filter_zlib) { Skeevy::Filters::ZlibCompression.new }
+
+    it 'adds the filter to the internal @filters variable' do
+      instance.add_filter(filter: filter_rot13)
+      expect(instance.instance_variable_get(:@filters)).to eq [filter_rot13]
+      instance.add_filter(filter: filter_zlib)
+      expect(instance.instance_variable_get(:@filters)).to eq [filter_rot13, filter_zlib]
+    end
+
+    it 'returns the same data put in regardless of filters' do
+      instance.add_filter(filter: filter_rot13)
+      instance.add_filter(filter: filter_zlib)
+      instance.write!(key: 'testing', content: 'testing_content')
+      expect(instance.read(key: 'testing')).to eq 'testing_content'
+    end
+  end
+
 end

data/spec/shared/engine.rb

@@ -54,4 +54,14 @@ RSpec.shared_examples 'a skeevy engine' do
     end
   end
 
+  describe '#keys' do
+    it 'lists all existing keys' do
+      puts the_engine.keys
+      k = 'keys_test-file.json'
+      k2 = 'a-b-c-file.json'
+      the_engine.write!(key: k, content: '{}')
+      the_engine.write!(key: k2, content: '{}')
+      expect(the_engine.keys.sort).to eq ['a-b-c-file.json', 'keys_test-file.json']
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -11,7 +11,7 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
-  config.after(:all) do
+  config.after(:each) do
     FileUtils.rm_rf(Dir["tmp/[^.]*"])
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skeevy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Craig Waterman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-30 00:00:00.000000000 Z
+date: 2015-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.4.2
+        version: '4.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.4.2
+        version: '4.4'
 description: A simple key-value store for objects
 email: craigwaterman@gmail.com
 executables: []
@@ -56,12 +56,17 @@ files:
 - lib/skeevy/engine.rb
 - lib/skeevy/engines/directory_file.rb
 - lib/skeevy/engines/symbolic_hash.rb
+- lib/skeevy/filter.rb
+- lib/skeevy/filters/rot_13.rb
+- lib/skeevy/filters/zlib_compression.rb
 - lib/skeevy/instance.rb
 - lib/skeevy/version.rb
 - skeevy.gemspec
 - spec/lib/skeevy/cutters/standard_key_spec.rb
 - spec/lib/skeevy/engines/directory_file_spec.rb
 - spec/lib/skeevy/engines/symbolic_hash_spec.rb
+- spec/lib/skeevy/filters/rot_13_spec.rb
+- spec/lib/skeevy/filters/zlib_compression_spec.rb
 - spec/lib/skeevy/instance_spec.rb
 - spec/lib/skeevy/version_spec.rb
 - spec/lib/skeevy_spec.rb
@@ -96,6 +101,8 @@ test_files:
 - spec/lib/skeevy/cutters/standard_key_spec.rb
 - spec/lib/skeevy/engines/directory_file_spec.rb
 - spec/lib/skeevy/engines/symbolic_hash_spec.rb
+- spec/lib/skeevy/filters/rot_13_spec.rb
+- spec/lib/skeevy/filters/zlib_compression_spec.rb
 - spec/lib/skeevy/instance_spec.rb
 - spec/lib/skeevy/version_spec.rb
 - spec/lib/skeevy_spec.rb