database_repository 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2759f6ce430a41dbea84649e41ce82436007c320
+  data.tar.gz: afba4cf371e3945ff917fe65a5628d7cdd349edb
+SHA512:
+  metadata.gz: 0755ed08edbd66294637ed1154f4e99dc75de0b39fb5b4749411f6f7ae530d9add6cb8f502c74d584b72cc7c0f132001f703d619943b2d5bb7faaa0327208ee4
+  data.tar.gz: ef110f7e7992a20d087d51348d56f5ba02d783a55b0e8f436b067a4c6c6230e27d1820b67474056ba5ad8bb2250041ff3fefcc1122c292208d3391fa8da46e00

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in database_repository.gemspec
+gemspec

data/README.md

@@ -0,0 +1,180 @@
+# DatabaseRepository
+
+[![Gem Version](https://badge.fury.io/rb/database_repository.svg)](https://badge.fury.io/rb/database_repository)
+[![Build Status](https://travis-ci.org/piotrjaworski/database_repository.svg?branch=master)](https://travis-ci.org/piotrjaworski/database_repository)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c4b1e02d0a40e9576cea/maintainability)](https://codeclimate.com/github/piotrjaworski/database_repository/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c4b1e02d0a40e9576cea/test_coverage)](https://codeclimate.com/github/piotrjaworski/database_repository/test_coverage)
+
+Welcome to the DatabaseRepository gem!
+This gem was written to provide an extra layer to your Ruby applications called **repositories**.
+Repositories are used to interact with our database - execute all queries.
+Thanks to them, you don't need to write anymore **ActiveRecord code** inside your models, controllers, and services - everything is much simpler to maintain!
+
+This gem requires just **ActiveRecord**, not **Rails** - feel free to use it without Rails in your Rack applications!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'database_repository'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install database_repository
+
+## How to create a repository
+
+To create a new repository, you just need to run a Rails generator (if you use Rails):
+
+    $ rails generate database_repository:repository your_repository_name
+
+For example:
+
+    $ rails generate database_repository:repository user
+
+A new repository will be generated under:
+- app/repositories/user_repository.rb
+
+You can also add the new repository to app/repositories, your class should inherit from `DatabaseRepository::Base` class, like:
+```ruby
+class UserRepository < DatabaseRepository::Base
+end
+```
+
+## Dependencies
+
+- ActiveRecord >= 3.2
+
+## Usage
+
+If you want to use your repository, you should create a new instance of a repository, then call a method which will return some data:
+```ruby
+users_repository = UserRepository.new
+users = users_repository.all
+user = users_repository.find(2)
+```
+
+By default, a repository maps to a model by a repository's name, for example:
+- UserRepository -> User
+- LineItemRepository -> LineItem
+- User::LineItemRepository -> User::LineItem
+
+If you want to change a model, you can redefine a class name:
+```ruby
+class UsersRepository < DatabaseRepository::Base
+  entity 'Model'
+end
+```
+
+#### Preimplemented methods:
+- `all`
+calls ActiveRecord **Model.all** method.
+
+- `build(attributes)`
+calls ActiveRecord **Model.new(attributes)** method.
+
+- `find(id)`
+calls ActiveRecord **Model.find(id)** method.
+Raises `DatabaseRepository::RecordNotFound` if a record is not found.
+
+- `find_by(id)`
+calls ActiveRecord **Model.find_by(id)** method.
+
+- `find_or_initialize_by(id)`
+calls ActiveRecord **Model.find_or_initialize_by(id)** method.
+
+- `find_or_create_by(attributes)`
+calls ActiveRecord **Model.find_or_create_by(attributes)** method.
+
+- `find_or_create_by!(attributes)`
+calls ActiveRecord **Model.find_or_create_by!(attributes)** method. Raises `DatabaseRepository::RecordInvalid` if a record is invalid.
+
+- `first(id)`
+calls ActiveRecord **Model.first(id)** method.
+
+- `first!(id)`
+calls ActiveRecord **Model.first!(id)** method.
+Raises `DatabaseRepository::RecordNotFound` if a record is not found.
+
+- `last(id)`
+calls ActiveRecord **Model.last(id)** method.
+
+- `last!(id)`
+calls ActiveRecord **Model.last!(id)** method.
+Raises `DatabaseRepository::RecordNotFound` if a record is not found.
+
+- `create(attributes)`
+calls ActiveRecord **Model.create(attributes)** method.
+
+- `create!(attributes)`
+calls ActiveRecord **Model.create!(attributes)** method.
+Raises `DatabaseRepository::RecordInvalid` if a record is invalid.
+
+- `update(id, attributes)`
+calls ActiveRecord **Model.update(id, attributes)** method.
+
+- `update!(id, attributes)`
+calls ActiveRecord **Model.update!(id, attributes)** method.
+Raises `DatabaseRepository::RecordInvalid` if a record is invalid.
+
+- `update_all(attributes)`
+calls ActiveRecord **Model.update_all(attributes)** method.
+
+- `delete(id)`
+calls ActiveRecord **Model.delete(id)** method.
+
+- `destroy(id)`
+calls ActiveRecord **Model.destoy(id)** method.
+
+- `destroy!(id)`
+calls ActiveRecord **Model.destroy!(id)** method.
+Raises `DatabaseRepository::RecordNotDestroyed` if a record cannot be destroyed.
+
+- `delete_all`
+calls ActiveRecord **Model.delete_all** method.
+
+- `destroy_all`
+calls ActiveRecord **Model.destroy_all** method.
+
+### Your own methods
+
+If you want to add your methods, just write a regular ActiveRecord code, for example:
+```ruby
+class UserRepository < DatabaseRepository::Base
+  def most_recent_by_name(name:, limit: 5)
+    where(name: name).
+    order(created_at: :desc).
+    limit(limit)
+  end
+end
+```
+
+Then, inside your service, controller or any other class:
+```ruby
+UserRepository.new.most_recent_by_name(name: 'Piotr Jaworski', limit: 10)
+```
+
+Voila! That's all!
+
+## TODO
+
+- Add Sequel support
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/piotrjaworski/database_repository. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+MIT License. Copyright 2018 Piotr Jaworski - http://piotrjaworski.pl.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "database_repository"
+
+# 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(__FILE__)

data/bin/setup

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

data/database_repository.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "database_repository/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "database_repository"
+  spec.version       = DatabaseRepository::VERSION
+  spec.authors       = ["Piotr Jaworski"]
+  spec.email         = ["piotrek.jaw@gmail.com"]
+
+  spec.summary       = %q{Simple database repository pattern for ActiveRecord.}
+  spec.description   = %q{Gem which provides simple database repository pattern for ActiveRecord with predefined basics methods.}
+  spec.homepage      = "https://github.com/piotrjaworski/database_repository"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activerecord", ">= 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+end

data/lib/database_repository/base.rb

@@ -0,0 +1,123 @@
+module DatabaseRepository
+  class RecordNotFound < StandardError; end
+  class RecordInvalid < StandardError; end
+  class RecordNotDestroyed < StandardError; end
+
+  class Base
+    class << self
+      attr_accessor :entity_class_name
+
+      def entity(entity_class_name)
+        @entity_class_name = entity_class_name
+      end
+    end
+
+    def all
+      entity.all
+    end
+
+    def build(**attributes)
+      entity.new(attributes)
+    end
+
+    def find(id)
+      entity.find(id)
+    rescue ActiveRecord::RecordNotFound => e
+      raise DatabaseRepository::RecordNotFound, e.message
+    end
+
+    def find_by(**attributes)
+      entity.find_by(attributes)
+    end
+
+    def find_or_initialize_by(**attributes)
+      entity.find_or_initialize_by(attributes)
+    end
+
+    def find_or_create_by(**attributes)
+      entity.find_or_create_by(attributes)
+    end
+
+    def find_or_create_by!(**attributes)
+      entity.find_or_create_by!(attributes)
+    rescue ActiveRecord::RecordInvalid => e
+      raise DatabaseRepository::RecordInvalid, e.message
+    end
+
+    def first
+      entity.first
+    end
+
+    def first!
+      entity.first!
+    rescue ActiveRecord::RecordNotFound => e
+      raise DatabaseRepository::RecordNotFound, e.message
+    end
+
+    def last
+      entity.last
+    end
+
+    def last!
+      entity.last!
+    rescue ActiveRecord::RecordNotFound => e
+      raise DatabaseRepository::RecordNotFound, e.message
+    end
+
+    def create(**attributes)
+      entity.create(attributes)
+    end
+
+    def create!(**attributes)
+      entity.create!(attributes)
+    rescue ActiveRecord::RecordInvalid => e
+      raise DatabaseRepository::RecordInvalid, e.message
+    end
+
+    def update(id, **attributes)
+      find(id).tap do |record|
+        record.update(attributes)
+      end
+    end
+
+    def update!(id, **attributes)
+      find(id).tap do |record|
+        record.update!(attributes)
+      end
+    rescue ActiveRecord::RecordInvalid => e
+      raise DatabaseRepository::RecordInvalid, e.message
+    end
+
+    def update_all(**attributes)
+      entity.update_all(attributes)
+    end
+
+    def delete(id)
+      find(id).delete
+    end
+
+    def destroy(id)
+      find(id).destroy
+    end
+
+    def destroy!(id)
+      find(id).destroy!
+    rescue ActiveRecord::RecordNotDestroyed => e
+      raise DatabaseRepository::RecordNotDestroyed, e.message
+    end
+
+    def delete_all
+      entity.delete_all
+    end
+
+    def destroy_all
+      entity.destroy_all
+    end
+
+    private
+
+    def entity
+      @_entity ||= Object.const_get(self.class.entity_class_name || self.class.name.match(/(.*)Repository/)[1])
+    end
+  end
+end

data/lib/database_repository/engine.rb

@@ -0,0 +1,5 @@
+module DatabaseRepository
+  class Engine < ::Rails::Engine
+    config.eager_load_paths += %W(#{config.root}/app/repositories)
+  end
+end

data/lib/database_repository/version.rb

@@ -0,0 +1,3 @@
+module DatabaseRepository
+  VERSION = '1.0.0'.freeze
+end

data/lib/database_repository.rb

@@ -0,0 +1,6 @@
+require 'database_repository/base'
+require 'database_repository/version'
+require 'database_repository/engine' if defined?(Rails)
+
+module DatabaseRepository
+end

data/lib/generators/database_repository/repository_generator.rb

@@ -0,0 +1,12 @@
+module DatabaseRepository
+  module Generators
+    class RepositoryGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      argument :repository_name, type: :string
+
+      def create_repository_file
+        template 'repository.rb', File.join('app', 'repositories', "#{repository_name.underscore}_repository.rb")
+      end
+    end
+  end
+end

data/lib/generators/database_repository/templates/repository.rb

@@ -0,0 +1,4 @@
+class <%= repository_name.camelize %>Repository < DatabaseRepository::Base
+  # Put your code here
+  # You can find more examples in https://github.com/piotrjaworski/database_repository
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: database_repository
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Piotr Jaworski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: Gem which provides simple database repository pattern for ActiveRecord
+  with predefined basics methods.
+email:
+- piotrek.jaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- database_repository.gemspec
+- lib/database_repository.rb
+- lib/database_repository/base.rb
+- lib/database_repository/engine.rb
+- lib/database_repository/version.rb
+- lib/generators/database_repository/repository_generator.rb
+- lib/generators/database_repository/templates/repository.rb
+homepage: https://github.com/piotrjaworski/database_repository
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Simple database repository pattern for ActiveRecord.
+test_files: []