repositor 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd4aae918948fed1130511573293f27eb04186f6
-  data.tar.gz: fd9fed701002b6723f1f2f92c0d162a4192eeaf8
+  metadata.gz: a5397ecf74b2b8bcffd0f97269bbf431c1f07a72
+  data.tar.gz: 4fe43a91b408049f3bf5029cfe3397785be327d3
 SHA512:
-  metadata.gz: 9c69491ab1086fb5b8a976ca4b6c94ee1a7d4049407e32c0516c71961e342fa9ab0a42c6d28ec4bc06afd5ee2702653d77b4107e344e245994f1d63113050373
-  data.tar.gz: 5de69c59cbfc9d6b96ee4fdd78119810241ee4e412b483b66ead93f96e065467a3fca6ec06f9aa98edfac867f65f35973dd1dbfa4075a543f0f5273342650aad
+  metadata.gz: f8204a1184c6a9523cb1247a0fdda409ce523a9458a27e459815b72ada0e9995cdfb72d46405ad38a54a17b22993cecee7ebaf646eadcebf8f63bc9102a266d3
+  data.tar.gz: 9dda4919b47be711e71f4aa003274d169cf01532e92343a12d16cce93c539d4f34cbca4504903dc723d7a83a1939cb2f795591cec850ddc3553f3166e91c8556

data/README.md

@@ -21,11 +21,17 @@ bundle install
 
 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..
+I split record instance manage and collection manage into two almost same (but not) layers - Repos & Queries
 
-With some helps of helper method your controller can be only 30-40 lines of code. Nothing more.
+**Repo** - for single record (:find, :new, :create, :update, :destroy)
 
-With RepoObject you controller could look something like this:
+**Query** - for collection of records (:all, :where and others)
+
+The main reason to user **RepoObject** is that your controller don't communicate with ORM layer (ActiveRecord or Mongoid). It will communicate with Repo/Query so you are not stricted about your database adapter or data API. It's some sort of anti-corruption layer also. 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 some support of `helper_method` your controller can be only 50-60 lines of code. Nothing more.
+
+With **Repo** and **Query** you controller could look something like this:
 ```ruby
 class ProductsController < ApplicationController
 
@@ -68,16 +74,23 @@ class ProductsController < ApplicationController
   # At view method `products` allows you access to the colelction
   # No any @'s anymore!
   def products
-    @products ||= repo.all
+    @products ||= query.all
   end
 
-  # Declaration if repo object:
+  # Declaration of repo object:
   def repo
     @products_repo ||= ProductRepo.new
   end
+
+  # Declaration of query object:
+  def query
+    @product_query ||= ProductQuery.new
+  end
   # By default repositor will try to find `Product` model and communicate with it
   # if you need specify other model, pass in params
-  # ProductRepo.new(model: SaleProduct)
+  # ProductRepo.new(model: TopProduct)
+  # or
+  # ProductQuery.new(model: SaleProduct)
 end
 ```
 
@@ -89,17 +102,18 @@ end
 
 **Or manually:**
 
-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.
+In `app` directory you need to create new `repos` and `queries` 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. (Same for queries)
 
+`app/repos/application_repo.rb`
 ```ruby
-class ApplicationRepo <  Repositor::ActiveRecordAdapter
+class ApplicationRepo <  Repositor::Repo::ActiveRecordAdapter
   # now supported only ActiveRecord but will be added more soon
   # 
   # Adapter allow you to use 4 default methods for CRUD:
   # :new, :create, :update, :destroy
   # 
-  # Only 2 for finding/quering records
-  # :find, :all
+  # Only 1 for find record
+  # :find
   # 
   # And additional helpers
   # find_or_initialize(id, friendly: false) => support for friendly_id gem
@@ -108,15 +122,22 @@ class ApplicationRepo <  Repositor::ActiveRecordAdapter
 end
 ```
 
-Than you need to create `product_repo.rb`:
+`app/queries/application_query.rb`
+```ruby
+class ApplicationQuery <  Repositor::Query::ActiveRecordAdapter
+  # now supported only ActiveRecord but will be added more soon
+  # 
+  # Adapter allow you to use 3 methods for CRUD:
+  # :all, :first, :last
+end
+```
+
+Than you need to create `app/repos/product_repo.rb`:
 ```ruby
 class ProductRepo < ApplicationRepo
   # here you have default methods for repository actions
   # if you want communicate with model class,
   # just can use model method to send it any method you need
-  def create_if(params, condition)
-    create(params) if condition
-  end
 
   # Very good approach is that you got a place where you can
   # control persistence process, define some logic and reuse it everywhere.
@@ -126,12 +147,30 @@ class ProductRepo < ApplicationRepo
     if result
       # trigger some event
     end
+
+    result # don't forgot return object
+  end
+end
+```
+
+and `app/queries/product_query.rb`
+```ruby
+class ProductQuery < ApplicationQuery
+  # here you can define all scopes
+  # ATTENTION! Your queries always must reutrn Relation (!!!)
+  
+  # Simple scopes extraction from model
+  def active
+    where(status: 'active')
   end
 
-  # You also can compose queries
-  # But recommended to extract such methods to QueryObject (aka finder)
-  def all_with_name_john
-    model.where(name: 'John')
+  def disabled(status: 'disabled')
+    where(status: 'active')
+  end
+  
+  # You can combine queries
+  def active_and_disabled
+    active | disabled
   end
 end
 ```

data/lib/generators/repos_generator.rb

@@ -1,8 +1,14 @@
 class ReposGenerator < Rails::Generators::Base
   def create_repos_file
     create_file "app/repos/application_repo.rb",
-"class ApplicationRepo
-  include Repositor::ActiveRecord
+"class ApplicationRepo < Repositor::Repo::ActiveRecordAdapter
+end
+"
+  end
+
+  def create_query_file
+    create_file "app/queries/application_query.rb",
+"class ApplicationQuery < Repositor::Query::ActiveRecordAdapter
 end
 "
   end

data/lib/repositor.rb

@@ -1,4 +1,9 @@
-require 'repositor/active_record'
+require 'repositor/base'
+
+require 'repositor/repo/active_record'
+require 'repositor/repo/instance_allow'
+
+require 'repositor/query/active_record'
 
 module Repositor
 end

data/lib/repositor/base.rb

@@ -0,0 +1,11 @@
+require 'active_support/inflector'
+
+module Repositor
+  class Base
+    attr_reader :model
+
+    def initialize(model: nil)
+      @model = model || self.class.to_s.chomp(self.class::TYPE).singularize.constantize
+    end
+  end
+end

data/lib/repositor/query/active_record.rb

@@ -0,0 +1,9 @@
+require 'active_support/core_ext/module/delegation'
+
+module Repositor::Query
+  class ActiveRecordAdapter < Repositor::Base
+    TYPE = 'Query'.freeze
+
+    delegate :all, :first, :last, to: :model
+  end
+end

data/lib/repositor/{active_record.rb → repo/active_record.rb}

@@ -1,18 +1,13 @@
 require 'active_support/core_ext/module/delegation'
-require 'active_support/inflector'
-require 'repositor/instance_allow'
+require 'repositor/repo/instance_allow'
 
-module Repositor
-  class ActiveRecordAdapter
+module Repositor::Repo
+  class ActiveRecordAdapter < Repositor::Base
     extend InstanceMethodsFilter
 
-    attr_reader :model
+    TYPE = 'Repo'.freeze
 
-    delegate :find, :all, :new, :create, :update, :destroy, to: :model
-
-    def initialize(model: nil)
-      @model = model || self.class.to_s.chomp("Repo").singularize.constantize
-    end
+    delegate :find, :new, :create, :update, :destroy, to: :model
 
     # Common find process with supporting of friendly_id params
     def find_or_initialize(id, friendly: false)

data/lib/repositor/{instance_allow.rb → repo/instance_allow.rb}

@@ -1,4 +1,4 @@
-module Repositor
+module Repositor::Repo
   module InstanceMethodsFilter
     attr_reader :allowed_methods
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: repositor
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Volodya Sveredyuk
@@ -73,8 +73,10 @@ files:
 - README.md
 - lib/generators/repos_generator.rb
 - lib/repositor.rb
-- lib/repositor/active_record.rb
-- lib/repositor/instance_allow.rb
+- lib/repositor/base.rb
+- lib/repositor/query/active_record.rb
+- lib/repositor/repo/active_record.rb
+- lib/repositor/repo/instance_allow.rb
 homepage: https://github.com/sveredyuk/repositor
 licenses:
 - MIT