repositor 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57ecdac0dba23e52a2837a0a56185f999b873d90
-  data.tar.gz: bf29c856e21fd9c84edb64114646164f350ce5d9
+  metadata.gz: 0e461148a09c7a400f415e1cc79503fe9a7d82f0
+  data.tar.gz: a5c378edf40ae7ad2eacf7c27482538ad29d3249
 SHA512:
-  metadata.gz: ffa9d513e8a76ac0d87c87b61919d094f452445182b6c6b1e90362efe5438afc9b4adf71284e10960c0f7ad6e3dd78989525479f84699dad48f17799a7eba58e
-  data.tar.gz: d41b29977d2bb2756f1464c82f9d799fb2d6d9ca5928b800128eb56baae17dca509ecb3acaf8ccd4a2ce32406af9d81529bfb8e297d0b8d52f48d0fa0f94d54d
+  metadata.gz: bef13f567c76add59904d26c9d11bd72d30cb89548d1d501af48c84cb289c2927a68132b43b45907c8e82d74b17fa4f855124bfd63f8f8083ac0114d4afc4fee
+  data.tar.gz: d7e3dee965a45d2b86b12e3c53efef35cd8eb68debe39691a6d415386211695a949278f07b8be1f12417200f41088dfea954c56cb182ae2c455b39d34de5845e

data/README.md

@@ -4,76 +4,49 @@
 
 ## Installation & Setup
 
-In gemfile:
+Manual:
+```
+gem install 'repositor'
+```
+
+For gemfile:
 ```ruby
 gem 'repositor'
 ```
 
-In console:
+And run in console:
 ```
-bundle
+bundle install
 ```
 
 ## 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 ;)
+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..
+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:
+With some helps of helper method your controller can be only 30-40 lines of code. Nothing more.
+
+With RepoObject you controller could 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
+  # you are free from any action callbacks...
+  # but define this 2 helper methods:
+  helper_method :product, :products
 
   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
+    @product = repo.create(product_params)
+    @product.valid? ? redirect_to(default_redirect) : render(:new)
   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
+    @product = repo.update(product, product_params)
+    @product.valid? ? redirect_to(default_redirect) : render(:edit)
   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
+    repo.destroy(product) and redirect_to default_redirect
   end
 
   private
@@ -82,13 +55,31 @@ class ProductsController < ApplicationController
     params.require(:product).permit(:name, :price, :dscription)
   end
 
+  def default_redirect
+    products_path
+  end
+
+  # Helper method that find or init new instance for you and cache it in ivar
+  # You can use it for at view show action just `product` method
+  # or for _form partial also `product`
+  def product
+    @product ||= repo.find(params[:id])
+  end
+
+  # Second helper that allow to cache all collection
+  # At view method `products` allows you access to the colelction
+  # No any @'s anymore!
+  def products
+    @products ||= repo.all
+  end
+
   # Declaration if repo object:
   def repo
-    @products_repo ||= ProductsRepo.new
+    @products_repo ||= ProductRepo.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)
+  # ProductRepo.new(model: SaleProduct)
 end
 ```
 
@@ -106,9 +97,9 @@ class ApplicationRepo
 end
 ```
 
-Than you need to create `products_repo.rb`:
+Than you need to create `product_repo.rb`:
 ```ruby
-class ProductsRepo < ApplicationRepo
+class ProductRepo < ApplicationRepo
   # here you will have default methods for repo actions
   # if you want communicate with model class,
   # just can use model method to send it any method you need
@@ -123,7 +114,7 @@ If check what exactly was done, including `Repository` module in base `Applicati
 
 `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
+class ProductRepo
   def all
     Product.all
   end
@@ -140,14 +131,12 @@ class ProductsRepo
     Product.create(product_params)
   end
 
-  def update(product_id, params)
-    find(product_id).tap do |product|
+  def update(params)
     product.update(params)
-    end
   end
 
-  def destroy(product_id)
-    find(product_id).destroy
+  def destroy(product)
+    product.destroy
   end
 end
 ```
@@ -155,6 +144,6 @@ If you need to add new method for model, just define it in repo file.
 Keep your model skinny.
 
 ## TODO
-* Specs on the way...
 * Add mongoid support
+* Add generators that generate repo folder and some `application_repo.rb`
 * Some improvements ? =)

data/lib/repositor/active_record.rb

@@ -24,6 +24,7 @@ module Repositor
 
     def update(record, record_params)
       record.update(record_params)
+      record
     end
 
     def destroy(record)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: repositor
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Volodya Sveredyuk