sequel_record_store 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43111fe5ad988d19f8c6b8d21cd58260f8030d4d
+  data.tar.gz: ecc5990de1b8871de6f6e431b95adeed1bfa9c20
+SHA512:
+  metadata.gz: f847d22b3c76f57e4a13cca6c40d65bc77bb8fe86b81b58c9629fff22afa98644db494f5e7c2bdd9dbf3d1d7aa29d84416c81b1111433411b686df0f7d02613a
+  data.tar.gz: 44e5d01b203c82923c1690e1185fbbef99c4b2dcd4305d36b0978d1ef19ffcc89749b0d433d42028ab665823d7efe83fffc1d365d32dd543e0e0f64f2ff00c06

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Paul Barry
+
+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,73 @@
+# Record Store
+
+Store records in your database using Sequel
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sequel_record_store'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install record_store
+
+## Usage
+
+If you have an application where you are working with records as hashes and you would like store them in your database using Sequel, this gem can help make that happen. To use Record Store, you should subclass the `SequelRecordStore` class at least once in your application. If for example you already have a reference to a Sequel database stored in a constant called `DB`, then you would do something lke this:
+
+```ruby
+class Store < SequelRecordStore
+  def self.database
+    DB
+  end
+end
+```
+
+Then for each table you want to store records in, you subclass that class:
+
+```ruby
+class UserStore < Store
+end
+```
+
+You can now store records in the `users` table like this:
+
+```ruby
+UserStore << { first_name: 'Paul', last_name: 'Barry' }
+```
+
+You can also add validations to your store, like this:
+
+```ruby
+class UserStore < Store
+  required_attributes :first_name, :last_name
+end
+```
+
+If you try to store a record without values for those attributes, you will get an error:
+
+```ruby
+UserStore << {}
+ # => { errors: ["First Name is required", "Last Name is required"]}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/record_store/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "record_store"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sequel_record_store.rb

@@ -0,0 +1,122 @@
+class SequelRecordStore
+  VERSION = "0.4.0"
+
+  class << self
+    def database
+      raise "You must setup your database"
+    end
+
+    def dataset_name
+      @dataset_name ||= name.sub(/Store$/,'').tableize.to_sym
+    end
+
+    def dataset
+      database[dataset_name]
+    end
+
+    def get(id)
+      dataset.where(id: id).first
+    end
+    alias_method :[], :get
+
+    def put(record)
+      new(record).put
+    end
+    alias_method :<<, :put
+
+    def type_column_map(database)
+      @type_column_map ||= database.schema(dataset_name).each_with_object({}) do |(column,metadata),map|
+        map[metadata[:db_type]] ||= []
+        map[metadata[:db_type]] << column
+      end
+    end
+
+    def validations
+      @validations ||= []
+    end
+
+    def required_attributes(*record)
+      record.each do |attribute|
+        validations << proc do
+          errors << "#{attribute.to_s.titleize} is required" unless @record[attribute].present?
+        end
+      end
+    end
+
+    def required_foreign_key(attribute, table)
+      validations << proc do
+        if @record[attribute].blank?
+          errors << "#{attribute} is required"
+        elsif database[table].where(id: @record[attribute]).get(:id).blank?
+          errors << "no #{table.to_s.singularize} with id=#{@record[attribute]}"
+        end
+      end
+    end
+  end
+
+  def initialize(record)
+    @record = record
+  end
+
+  def put
+    typecast
+    transform
+    return { errors: 'no record provided' } if @record.blank?
+    validate
+    return { errors: errors } if errors.present?
+
+    save
+  end
+
+  def save
+    if exists?
+      update
+    else
+      insert
+    end
+    @record
+  end
+
+  def database
+    self.class.database
+  end
+
+  def dataset
+    self.class.dataset
+  end
+
+  def errors
+    @errors ||= []
+  end
+
+  def typecast
+    if database.database_type == :postgres
+      Array(self.class.type_column_map(database)['json']).each do |json_column|
+        if @record[json_column]
+          @record[json_column] = Sequel.pg_json(@record[json_column])
+        end
+      end
+    end
+  end
+
+  def transform
+  end
+
+  def validate
+    self.class.validations.each do |validation|
+      instance_eval(&validation)
+    end
+  end
+
+  def exists?
+    !dataset.select(1).where(id: @record[:id]).empty?
+  end
+
+  def insert
+    @record[:id] = dataset.insert(@record.except(:errors))
+  end
+
+  def update
+    dataset.where(id: @record[:id]).update(@record.except(:id, :errors))
+  end
+end

data/record_store.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "sequel_record_store"
+  spec.version       = "0.4.0"
+  spec.authors       = ["Paul Barry"]
+  spec.email         = ["mail@paulbarry.com"]
+
+  spec.summary       = %q{Easily store records in your database with Sequel}
+  spec.homepage      = "http://github.com/pjb3/sequel_record_store"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: sequel_record_store
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Paul Barry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- mail@paulbarry.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sequel_record_store.rb
+- record_store.gemspec
+homepage: http://github.com/pjb3/sequel_record_store
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Easily store records in your database with Sequel
+test_files: []