s3db 0.0.0

data/spec/lib/s3db/record_spec.rb

@@ -0,0 +1,286 @@
+require 'spec_helper'
+
+RSpec.describe S3DB::Record do
+  before :each do
+    S3DB::FileBackend.delete(TEST_DB_BASE_PATH)
+    @backend = S3DB::FileBackend.create(TEST_DB_BASE_PATH)
+    @database = S3DB::Database.create(@backend, 'testdb')
+    @collection = S3DB::Collection.create(@database, 'testcoll')
+  end
+
+  after :each do
+    S3DB::FileBackend.delete(TEST_DB_BASE_PATH)
+  end
+
+  class TestRecord
+    include S3DB::Record
+  end
+
+  describe S3DB::Record::ClassMethods do
+    before :each do
+      TestRecord.id_generator nil
+      TestRecord.id_field nil
+      TestRecord._database = nil
+      TestRecord._collection = nil
+    end
+
+    it 'responds to setters' do
+      expect(TestRecord).to respond_to(:database)
+      expect(TestRecord).to respond_to(:collection_name)
+      expect(TestRecord).to respond_to(:id_generator)
+      expect(TestRecord).to respond_to(:id_field)
+      expect(TestRecord).to respond_to(:string)
+      expect(TestRecord).to respond_to(:all)
+      expect(TestRecord).to respond_to(:find)
+      expect(TestRecord).to respond_to(:create)
+    end
+
+    describe '::database' do
+      it 'sets @_database' do
+        expect(TestRecord._database).to be_nil
+        expect(TestRecord.database(:db)).to eq :db
+        expect(TestRecord._database).to eq :db
+      end
+    end
+
+    describe '::collection_name' do
+      it 'sets @_collection to a new collection with the name' do
+        expect(TestRecord._collection).to be_nil
+        TestRecord.database(@database)
+        expect(TestRecord.collection_name(@collection.name)).to \
+          be_a(S3DB::Collection)
+        expect(TestRecord._collection).to be_a(S3DB::Collection)
+        expect(TestRecord._collection.name).to eq @collection.name
+      end
+    end
+
+    describe '::id_generator' do
+      it 'sets @_id_generator' do
+        proc = Proc.new {}
+        expect(TestRecord._id_generator).to be_nil
+        expect(TestRecord.id_generator(proc)).to eq proc
+        expect(TestRecord._id_generator).to eq proc
+      end
+    end
+
+    describe '::id_field' do
+      it 'sets @_database' do
+        TestRecord._id_field = nil
+        expect(TestRecord._id_field).to be_nil
+        expect(TestRecord.id_field(:id)).to eq 'id'
+        expect(TestRecord._id_field).to eq 'id'
+      end
+    end
+
+    describe '::string' do
+      it 'adds a key to the schema with String value' do
+        expect(TestRecord._schema).to be_nil
+        expect(TestRecord.string(:name)).to eq({'name' => 'String'})
+        expect(TestRecord._schema).to eq({'name' => 'String'})
+        expect(TestRecord.string(:word)).to eq({'name' => 'String', 'word' => 'String'})
+        expect(TestRecord._schema).to eq({'name' => 'String', 'word' => 'String'})
+      end
+    end
+
+    describe '::all' do
+      it 'lists all available records' do
+        TestRecord.database @database
+        TestRecord.collection_name @collection.name
+
+        expect(TestRecord._collection).to receive(:list_records) {[]}
+        TestRecord.all
+      end
+    end
+
+    describe '::find' do
+      let(:filename) { 'testfile' }
+
+      it 'looks up a record by filename' do
+        TestRecord.database @database
+        TestRecord.collection_name @collection.name
+
+        expect(TestRecord._database.backend).to \
+          receive(:read_record) \
+          .with(TestRecord._database.name, TestRecord._collection.name, filename + '.json') \
+          .and_return('{}')
+        TestRecord.find(filename)
+      end
+
+      it 'raises an error with a missing file' do
+        TestRecord.database @database
+        TestRecord.collection_name @collection.name
+
+        expect(TestRecord._database.backend).to \
+          receive(:read_record).with(
+            TestRecord._database.name,
+            TestRecord._collection.name,
+            filename + '.json'
+          )
+
+        expect do
+          TestRecord.find(filename)
+        end.to raise_error ArgumentError, 'missing record!'
+      end
+    end
+
+    describe 'create' do
+      before :each do
+        TestRecord.database @database
+        TestRecord.collection_name @collection.name
+      end
+
+      let(:data) do
+        Hash.new
+      end
+
+      it 'instantiates a record' do
+        expect(TestRecord).to receive(:new).with(data).and_call_original
+        allow_any_instance_of(TestRecord).to receive(:save)
+
+        TestRecord.create(data)
+      end
+
+      it 'saves a record' do
+        expect_any_instance_of(TestRecord).to receive(:save)
+        allow(TestRecord).to receive(:new).and_call_original
+
+        TestRecord.create(data)
+      end
+    end
+  end
+
+  describe 'instance methods' do
+    subject do
+      TestRecord.id_field nil
+      TestRecord.id_generator nil
+      TestRecord.database @database
+      TestRecord.collection_name @collection.name
+      TestRecord.new({})
+    end
+
+    describe '#initialize' do
+      it 'sets data' do
+        expect(TestRecord.new({}).instance_variable_get(:@data)).to eq({})
+      end
+    end
+
+    describe '#new_record?' do
+      it 'returns true when the record has no _id' do
+        subject.instance_variable_set(:@data, {})
+        expect(subject.new_record?).to eq true
+      end
+
+      it 'returns false when the record has an _id' do
+        subject.instance_variable_set(:@data, {'_id' => 'present'})
+        expect(subject.new_record?).to eq false
+      end
+    end
+
+    describe '#save' do
+      it 'sets the id' do
+        expect(subject).to receive(:_set_id)
+
+        subject.save
+      end
+
+      it 'writes to disk' do
+        subject.save
+        expect(subject.class._database.backend).to \
+          receive(:write_record).with(
+            subject.class._database.name,
+            subject.class._collection.name,
+            subject.__send__(:_filename),
+            subject.data.to_json,
+          )
+
+        subject.save
+      end
+    end
+
+    describe '#save!' do
+      it 'raises an error on save failure' do
+        expect(subject).to receive(:save).and_return(false)
+
+        expect { subject.save! }.to raise_error ArgumentError, 'failed to save!'
+      end
+    end
+
+    describe '#update' do
+      it 'updates the data' do
+        subject.save
+        expect(subject.data).to eq({'_id' => subject._id})
+        expect(subject.update({'name' => 'jack'})).to eq subject
+        expect(subject.data).to eq({'name' => 'jack', '_id' => subject._id})
+      end
+    end
+
+    describe '#_id' do
+      it 'returns the _id key from @data' do
+        expect(subject._id).to be_nil
+
+        subject.instance_variable_set(:@data, {'_id' => 'myid' })
+        expect(subject._id).to eq('myid')
+      end
+    end
+
+    describe '#_id=' do
+      it 'sets the _id key in @data' do
+        subject.instance_variable_set(:@data, {})
+        expect(subject._id=('otherid')).to eq('otherid')
+        expect(subject.instance_variable_get(:@data)).to eq({'_id' => 'otherid'})
+      end
+    end
+
+    describe 'private #_filename' do
+      it 'appends .json to the _id' do
+        subject._id = 'fileid'
+        expect(subject.__send__(:_filename)).to eq('fileid.json')
+      end
+    end
+
+    describe 'private #_set_id' do
+      it 'returns the _id if set' do
+        subject._id = 'newid'
+        TestRecord._id_generator = Proc.new {}
+        TestRecord._id_field = nil
+        expect(subject.class._id_generator).to_not receive(:call)
+        expect(UUIDTools::UUID).to_not receive(:random_create)
+        expect(subject.__send__(:_set_id)).to eq('newid')
+        expect(subject._id).to eq('newid')
+      end
+
+      it 'sets a uuid if _id is not set and _id_generator is nil' do
+        subject._id = nil
+        TestRecord._id_generator = nil
+        TestRecord._id_field = 'id'
+        expect(UUIDTools::UUID).to receive(:random_create).and_call_original
+
+        expect(subject.__send__(:_set_id)).to match(/\w+\-\w+\-\w+-\w+-\w+/)
+      end
+
+      it 'sets a uuid if _id is not set and _id_field is nil' do
+        subject._id = nil
+        TestRecord._id_generator = Proc.new { |n| 'proc' }
+        TestRecord._id_field = nil
+        expect(UUIDTools::UUID).to receive(:random_create).and_call_original
+
+        expect(subject.__send__(:_set_id)).to match(/\w+\-\w+\-\w+-\w+-\w+/)
+      end
+
+      it 'calls the proc if _id is not set but _id_field and _id_generator are' do
+        subject
+        TestRecord.id_generator Proc.new { |n| "#{n}proc" }
+        TestRecord.id_field 'name'
+        subject._id = nil
+        subject.instance_variable_set(:@data, {'name' => 'jack' })
+
+        expect(subject.__send__(:_set_id)).to eq('jackproc')
+      end
+    end
+
+    describe 'private #_valid' do
+      it 'checks the schema'
+    end
+  end
+end
+

data/spec/lib/s3db/utils_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe S3DB::Utils do
+  describe '::sanitize' do
+    it 'only allows word characters' do
+      [
+        'test',
+        '383',
+        'HjLoo',
+      ].each do |input|
+        expect do
+          S3DB::Utils.sanitize(input)
+        end.to_not raise_error
+      end
+
+      [
+        'te st',
+        383,
+        String,
+      ].each do |input|
+        expect do
+          S3DB::Utils.sanitize(input)
+        end.to raise_error ArgumentError, 'invalid input!'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,110 @@
+require 'rubygems'
+require 'rspec'
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/spec'
+end
+
+require_relative '../lib/s3db'
+
+TEST_DB_BASE_PATH = '/tmp/s3dbtestpath'
+
+FileUtils.rm_rf(TEST_DB_BASE_PATH)
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: s3db
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Jack Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.5
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.6.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: S3-backed storage engine
+email:
+- jack@brownjohnf.com
+executables:
+- s3db
+extensions: []
+extra_rdoc_files: []
+files:
+- "./lib/s3db.rb"
+- "./s3db.gemspec"
+- Gemfile
+- Gemfile.lock
+- bin/s3db
+- lib/s3db.rb
+- lib/s3db/backend.rb
+- lib/s3db/collection.rb
+- lib/s3db/database.rb
+- lib/s3db/file_backend.rb
+- lib/s3db/record.rb
+- lib/s3db/utils.rb
+- spec/lib/s3db/collection_spec.rb
+- spec/lib/s3db/database_spec.rb
+- spec/lib/s3db/file_backend_spec.rb
+- spec/lib/s3db/record_spec.rb
+- spec/lib/s3db/utils_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/brownjohnf/s3db
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Leverage the endless cheap capacity of s3 for high-latency storage
+test_files:
+- spec/lib/s3db/collection_spec.rb
+- spec/lib/s3db/database_spec.rb
+- spec/lib/s3db/file_backend_spec.rb
+- spec/lib/s3db/record_spec.rb
+- spec/lib/s3db/utils_spec.rb
+- spec/spec_helper.rb