repositor 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c7720d2c653d1f7eabf57f0d4030d6da5472797
-  data.tar.gz: 130e9b1ec4a0fb5d25091c8aec2fd183e6c37971
+  metadata.gz: 3c3833d6329cc6b39385161b5d29bffc8fb434ec
+  data.tar.gz: 110ff33c7d808f0684de45f132114a3495d48e8c
 SHA512:
-  metadata.gz: 73c039bee755096139304fc64ba3116bebfe0860b6f40a5ef7cfa5f3755694a569ca09bd89d313e4f9036d91f9f1c6c22ad6593a0cb19aae19770cbc51703202
-  data.tar.gz: e2f1b570834ef3a20524aafc615500fc53dfc859e520b6e289d0c9bed3a40bc14376f1e6b9ab13175077f239730a865b975bd7ebb994dcffd4be091074ad9e4d
+  metadata.gz: 401a007577f4c87b4b86dde1f7a3ae677170c3cae3c3783d0232efe7639dd12fdac19d3967eb88560600f1774e469253ec11035e34edfb1ca3e4b29cb8990a48
+  data.tar.gz: ff238393c27734406b4d3cfde6c74f138f3f21bb60ae099cfa523d9119464488cf441630210c096448ca3bb59c2015b779e356e690d4641b26ad68f12817bb9d

data/README.md

@@ -0,0 +1,152 @@
+# Repositor
+
+## Installation & Setup
+
+In gemfile:
+```ruby
+gem 'repositor'
+```
+
+In console:
+```
+bundle
+```
+
+## Description
+
+This gem is an implementation of Repository Pattern described in book [Fearless Refactoring Rails Controllers](http://rails-refactoring.com/) by Andrzej Krzywda 2014 (c). Awesome book, recommend read for all who are scary open own controller files ;)
+
+The main reason to user RepoObject is that your controller don't communicate with ORM layer (ActiveRecord or Mongoid). It must communicate with Repo layer so you are not stricted about your database adapter. If in future you will want to change it, you will need just to reconfigure your Repository layer. Sounds nice. Let's try it..
+
+With RepoObject you controller must look something like this:
+```ruby
+class ProductsController < ApplicationController
+
+  # you are free from action callbacks...
+
+  def index
+    @products = repo.all # you communicate with repo object, not with model!
+  end
+
+  def show
+    @product = repo.find(params[:id]) # with repo... only...
+  end
+
+  def new
+    @product = repo.new # it's awesome! no?
+  end
+
+  def edit
+    @product = repo.find(params[:id]) # some dry?
+  end
+
+  def create
+    respond_to do |format|
+      @product = repo.create(product_params) # send params to repo
+      if @product.valid? # just check for valid, not for create action
+        format.html { redirect_to @product, notice: 'Product was successfully created.' }
+        format.json { render :show, status: :created, location: @product }
+      else
+        format.html { render :new }
+        format.json { render json: @product.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  def update
+    respond_to do |format|
+      @product = repo.update(params[:id], product_params) # give repo id of record and params for update
+      if @product.valid? # only validations
+        format.html { redirect_to @product, notice: 'Product was successfully updated.' }
+        format.json { render :show, status: :ok, location: @product }
+      else
+        format.html { render :edit }
+        format.json { render json: @product.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  def destroy
+    repo.destroy(params[:id]) # destroy also throw repo object
+    respond_to do |format|
+      format.html { redirect_to products_url, notice: 'Product was successfully destroyed.' }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+
+  def product_params
+    params.require(:product).permit(:name, :price, :dscription)
+  end
+
+  # Declaration if repo object:
+  def repo
+    @products_repo ||= ProductsRepo.new
+  end
+  # By default repositor will try to find `Product` model and communicate with it
+  # if you need specify other model, pass in params
+  # ProductsRepo.new(model: SaleProduct)
+end
+```
+
+## How to use
+
+
+In `app` directory you need to create new `repos` directory . Recomended to create `application_repo.rb` and inherit from it all repos, so you could keep all your repos under single point of inheritance.
+
+```ruby
+class ApplicationRepo
+  # include ORM submodule
+  # now supported only ActiveRecord
+  # more will added soon
+  include Repositor::ActiveRecord
+end
+```
+
+Than you need to create `products_repo.rb`:
+```ruby
+class ProductsRepo < ApplicationRepo;
+  # here you will have default methods for repo actions
+end
+```
+and that's all... magic already happened (no)
+
+If check what exactly was done, including `Repository` module in base `ApplicationRepo` will add default CRUD methods to all repos that will be inherited from it. That's all. No magic.
+
+`Repositor` did for you a lot of dry work. In other case for each repo you must make identical methods, like this:
+```ruby
+class ProductsRepo
+  def find(product_id)
+    Product.find(product_id)
+  end
+
+  def all
+    Product.all
+  end
+
+   def new
+    Product.new
+  end
+
+  def update(product_id, params)
+    find(product_id).tap do |product|
+    product.update(params)
+    end
+  end
+
+  def destroy(product_id)
+    find(product_id).destroy
+  end
+
+  def create(product_params)
+    Product.create(product_params)
+  end
+end
+```
+If you need to add new method to repo, just define it in repo file.
+
+## TODO
+* Specs on the way...
+* Add mongoid support
+* Some improvements ? =)

data/lib/repositor/active_record.rb

@@ -0,0 +1,35 @@
+module Repositor
+  module ActiveRecord
+    attr_reader :model
+
+    def initialize(model: nil)
+      @model = model || self.class.to_s.chomp("Repo").singularize.constantize
+    end
+
+    def find(record_id)
+      model.send :find, record_id
+    end
+
+    def all
+      model.send :all
+    end
+
+    def new
+      model.send :new
+    end
+
+    def create(record_params)
+      model.send :create, record_params
+    end
+
+    def update(record_id, record_params)
+      find(record_id).tap do |record|
+        record.update(record_params)
+      end
+    end
+
+    def destroy(record_id)
+      find(record_id).destroy
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: repositor
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Volodya Sveredyuk
@@ -36,7 +36,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/repositor.rb
+- lib/repositor/active_record.rb
 homepage: https://github.com/sveredyuk/repositor
 licenses:
 - MIT