pg_adaptor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77ee8b9297e7e49576b550b2dda9e13f19745a96
+  data.tar.gz: 991e6aa124ef7d4a6c6fd4863e11ba0f41e82f1c
+SHA512:
+  metadata.gz: 669f023507c1d760065dd41a189550646b67009f56c8ff9bb6852fc6725791e8c7583e5185bb57b98eb59ff8579496b6c43645604fca4a4065db058c7499c1de
+  data.tar.gz: 57c9d1718a80a4784f87fd136fa981857fcd3c516cd62409013d2a80b11ef01ca75b8cc738e36f82516f219f9126935982bc268033e4be1c8a1d7c5ebd13c2c2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.3.1
+services: postgresqe
+before_script:
+  - psql -c 'create database pg_adaptor_test;' -U postgres

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongo_adaptor.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Jon Rowe
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,25 @@
+# PGAdaptor
+
+A simple PG handler. Translates Structs into PG and back.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pg_adaptor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_adaptor
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new :spec
+
+task :default => [:spec]

data/lib/pg_adaptor/version.rb

@@ -0,0 +1,3 @@
+class PGAdaptor
+  VERSION = "0.0.1"
+end

data/lib/pg_adaptor.rb

@@ -0,0 +1,60 @@
+require 'sequel'
+require "pg_adaptor/version"
+
+class PGAdaptor
+  class << self
+    attr_accessor :db
+  end
+
+  def initialize name, klass
+    @table = self.class.db[name]
+    @klass = klass
+  end
+
+  def insert model
+    @table.insert process(model)
+  end
+
+  def upsert model, opts = { field: :id }
+    values = process model
+    @table.insert_conflict(target: opts[:field], update: values).insert values
+  end
+
+  def update model, query = { id: model.id }
+    @table.where(query).update process(model)
+  end
+
+  def fetch selector = {}, opts = {}
+    build @table.where(selector).first
+  end
+
+  def remove selector = {}
+    @table.where(selector).delete
+  end
+
+  def find selector = {}
+    @table.where(selector).map { |row| build row }
+  end
+
+private
+
+  def build result
+    @klass.new.tap do |model|
+      result.each { |field,value| model[field] = value }
+    end
+  end
+
+  def process(model)
+    fields = {}
+    model.each_pair do |field,value|
+      next if field == :id && value.nil?
+      if Array === value
+        fields[field] = Sequel.pg_array value
+      else
+        fields[field] = value
+      end
+    end
+    fields
+  end
+
+end

data/pg_adaptor.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/pg_adaptor/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jon Rowe"]
+  gem.email         = ["hello@jonrowe.co.uk"]
+  gem.description   = %q{A simple pg handler. Translates Structs into PG and back.}
+  gem.summary       = %q{A simple pg handler. Translates Structs into PG and back.}
+  gem.homepage      = "https://github.com/JonRowe/PGAdaptor"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "pg_adaptor"
+  gem.require_paths = ["lib"]
+  gem.version       = PGAdaptor::VERSION
+
+  gem.add_dependency 'pg'
+  gem.add_dependency 'sequel'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/spec/pg_adaptor_spec.rb

@@ -0,0 +1,147 @@
+require 'pg_adaptor'
+
+RSpec.describe 'adapting structs into pg' do
+  let(:db) { Sequel.postgres 'pg_adaptor_test'  }
+
+  before do
+    PGAdaptor.db = db
+    db.extension :pg_array
+    db.create_table :test_table do
+      primary_key :id
+      String :name
+      String :other
+      column :members, "text[]"
+    end
+  end
+
+  after do
+    db.drop_table :test_table
+  end
+
+  describe 'db setup' do
+    it 'can be configured' do
+      PGAdaptor.db = fake = double
+      expect(PGAdaptor.db).to eq fake
+    end
+  end
+
+  describe 'using the adaptor' do
+    let(:klass)      { Struct.new :name, :other, :members, :id }
+    let(:adaptor)    { PGAdaptor.new :test_table, klass }
+    let(:table)      { db[:test_table] }
+
+    describe 'with a new model' do
+      let(:model) { klass.new 'Test Model','Some Data',['Some Members']  }
+      let(:data)  { table.order(:id).last }
+
+      shared_examples_for 'creates a record' do
+        it 'changes the number of items in the table' do
+          expect { perform }.to change { table.count }.by(1)
+        end
+        it 'generates an id, ignoring any set key' do
+          perform
+          expect(data[:id]).to be_a Integer
+        end
+      end
+
+      shared_examples_for 'new model' do
+        it_should_behave_like 'creates a record'
+        it 'sets my fields and values' do
+          perform
+          expect(data[:name]).to  eq 'Test Model'
+          expect(data[:other]).to eq 'Some Data'
+          expect(data[:members]).to eq ['Some Members']
+        end
+      end
+
+      context 'inserting' do
+        let(:perform) { adaptor.insert model }
+        it_should_behave_like 'new model'
+      end
+
+      context 'upserting' do
+        let(:perform) { adaptor.upsert model }
+        it_should_behave_like 'new model'
+      end
+    end
+
+    describe 'with an existing model' do
+      let(:model) { klass.new 'Test Model','Some Data',['Some Other Members'] }
+      let(:id)    { table.insert(name: 'My Model', other: 'Some Value', members: Sequel.pg_array(['Some Members'])) }
+
+      before do
+        model.id = id
+      end
+
+      shared_examples_for 'modifying an existing model' do
+        let(:data) { table.order(:id).last }
+
+        it 'doesnt change the number of items in the table' do
+          expect { perform }.to change { table.count }.by(0)
+        end
+        it 'sets my fields and values' do
+          perform
+          expect(data[:id]).to eq model.id
+          expect(data[:name]).to  eq 'Test Model'
+          expect(data[:other]).to eq 'Some Data'
+          expect(data[:members]).to eq ['Some Other Members']
+        end
+      end
+
+      describe 'to update it' do
+        let(:perform) { adaptor.update model }
+        it_should_behave_like 'modifying an existing model'
+      end
+
+      describe 'to upsert it' do
+        let(:perform) { adaptor.upsert model }
+        it_should_behave_like 'modifying an existing model'
+      end
+
+      describe 'to fetch it' do
+        let(:result) { adaptor.fetch(id: id) }
+
+        it "returns a class" do
+          expect(result).to be_a klass
+        end
+        specify "the classes fields are set correctly" do
+          expect(result.id).to      eq id
+          expect(result.name).to    eq 'My Model'
+          expect(result.other).to   eq 'Some Value'
+          expect(result.members).to eq ['Some Members']
+        end
+      end
+
+      describe 'to remove it' do
+        it 'removes the record matching the selector' do
+          expect {
+            adaptor.remove(id: id)
+          }.to change { table.count }.to 0
+        end
+      end
+    end
+
+    describe 'finding multiples' do
+      before do
+        3.times do |i|
+          table.insert(name: 'My Model', other: i)
+        end
+        3.times do |i|
+          table.insert(name: 'Other Model', other: i)
+        end
+      end
+
+      let(:result) { adaptor.find(name: 'My Model') }
+
+      it 'returns 3 models' do
+        expect(result.count).to eq 3
+      end
+      it 'translates all to klass' do
+        expect(result.all? { |k| k.is_a? klass }).to be true
+      end
+      it 'gets them all' do
+        expect(result.map(&:other)).to eq ['0', '1', '2']
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: pg_adaptor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Rowe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple pg handler. Translates Structs into PG and back.
+email:
+- hello@jonrowe.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pg_adaptor.rb
+- lib/pg_adaptor/version.rb
+- pg_adaptor.gemspec
+- spec/pg_adaptor_spec.rb
+homepage: https://github.com/JonRowe/PGAdaptor
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A simple pg handler. Translates Structs into PG and back.
+test_files:
+- spec/pg_adaptor_spec.rb