repositor 0.7.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 025d643d69da495aac7845e4883956df337637f5
-  data.tar.gz: 221bc1c11d9aaaadd9fab6cbdac45a466fe9a43e
+  metadata.gz: bd4aae918948fed1130511573293f27eb04186f6
+  data.tar.gz: fd9fed701002b6723f1f2f92c0d162a4192eeaf8
 SHA512:
-  metadata.gz: add4bbf1d341b89d56dbec5e01b31424dce4f8366d83d5e8bf02083b2ee57ff65f386c7366c34406562363ea10c380d8511eeed1c379fc86195082ab849b0f25
-  data.tar.gz: 0f3672f250c82572ee4f0cfa4cf263fcc27c4cb364936075ac3efc60c5d3327cb42e6e7b225250ea9377fedf9b685856cbbc5c9c84b67579481018919ee3a32e
+  metadata.gz: 9c69491ab1086fb5b8a976ca4b6c94ee1a7d4049407e32c0516c71961e342fa9ab0a42c6d28ec4bc06afd5ee2702653d77b4107e344e245994f1d63113050373
+  data.tar.gz: 5de69c59cbfc9d6b96ee4fdd78119810241ee4e412b483b66ead93f96e065467a3fca6ec06f9aa98edfac867f65f35973dd1dbfa4075a543f0f5273342650aad

data/README.md

@@ -1,7 +1,5 @@
 # Repositor
 
-[gem]: https://rubygems.org/gems/repositor
-
 ## Installation & Setup
 
 Manual:
@@ -63,7 +61,7 @@ class ProductsController < ApplicationController
   # 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])
+    @product ||= repo.find_or_initialize(params[:id])
   end
 
   # Second helper that allow to cache all collection
@@ -85,7 +83,6 @@ end
 
 ## How to use
 
-
 **By generator:**
 
 `rails generate repos`
@@ -95,11 +92,19 @@ end
 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 be added soon
-  include Repositor::ActiveRecord
+class ApplicationRepo <  Repositor::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
+  # 
+  # And additional helpers
+  # find_or_initialize(id, friendly: false) => support for friendly_id gem
+  # or
+  # friendly_find(slugged_id)
 end
 ```
 
@@ -109,62 +114,46 @@ 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 all_with_name_john
-    model.where(name: 'John')
-  end
-
   def create_if(params, condition)
     create(params) if condition
   end
-end
-```
-
-Also `Repositor` will redirect all missing methods to instance if it was passed as first argument:
-```ruby
-product_repo.new_record?(product)
-```
-same as:
-```ruby
-product.new_record?
-```
-Only with the reason that you are not linked with data, only with it repo.
 
-and that's all...
+  # Very good approach is that you got a place where you can
+  # control persistence process, define some logic and reuse it everywhere.
+  def update(record, params)
+    result = record.update(params) if params[:ok] == 'ok'
 
-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.
-
-`Repositor` did for you a lot of dry work. In other case for each repo you must make identical methods, like this:
-```ruby
-class ProductRepo
-  def all
-    Product.all
+    if result
+      # trigger some event
+    end
   end
 
-  def new
-    Product.new
-  end
-
-  def find(product_id)
-    Product.find(product_id)
+  # You also can compose queries
+  # But recommended to extract such methods to QueryObject (aka finder)
+  def all_with_name_john
+    model.where(name: 'John')
   end
+end
+```
 
-  def create(product_params)
-    Product.create(product_params)
-  end
+Also `Repositor` allow redirect defined record methods to instance if it was passed as first argument:
+```ruby
+class ProductRepo < ApplicationRepo
+  allow_instance_methods :new_record?
+end
 
-  def update(params)
-    product.update(params)
-  end
+product_repo.new_record?(product)
+# same as:
+product.new_record?
 
-  def destroy(product)
-    product.destroy
-  end
-end
+# And not allowed will raise exception
+product_repo.persited?(product) # => NoMethodError
 ```
-If you need to add new method for model, just define it in repo file.
-Keep your model skinny.
+Only with the reason that you are not linked with data, only with it repo.
+
+**Keep your model skinny and without business logic.**
 
 ## TODO
 * Add mongoid support
-* Add generators that generate repo folder and some `application_repo.rb`
+* Add sequel support
 * Some improvements ? =)

data/lib/repositor/active_record.rb

@@ -1,8 +1,11 @@
 require 'active_support/core_ext/module/delegation'
 require 'active_support/inflector'
+require 'repositor/instance_allow'
 
 module Repositor
-  module ActiveRecord
+  class ActiveRecordAdapter
+    extend InstanceMethodsFilter
+
     attr_reader :model
 
     delegate :find, :all, :new, :create, :update, :destroy, to: :model
@@ -11,23 +14,43 @@ module Repositor
       @model = model || self.class.to_s.chomp("Repo").singularize.constantize
     end
 
-    def friendly_find(id)
-      model.friendly.find(id)
-    end
-
+    # Common find process with supporting of friendly_id params
     def find_or_initialize(id, friendly: false)
       friendly ? friendly_find(id) : model.find(id)
     rescue ::ActiveRecord::RecordNotFound
       model.new
     end
 
+    # Support for `friendly_id` gem out of box
+    def friendly_find(slugged_id)
+      model.friendly.find(slugged_id)
+    end
+
+    # All methods that have instance object as first argument
+    # will be redirected to itself with all other arguments
+    # `some_repo.new_record?(record)`
+    # same as
+    # `record.new_record?`
+    # But gives you more control under persistence process
     def method_missing(method, *args)
+      # Break if first argument was not a model record
       return unless args[0].instance_of? model
 
-      unless args.drop(1).empty?
-        args[0].send(method, args.drop(1))
+      # Super if allowed_methods not defined or in not included in array
+      am = self.class.allowed_methods
+      super if am.nil? || !am.include?(method)
+
+      resend_method(method, args)
+    end
+
+    def resend_method(method, args)
+      # All except first argumet is a record params
+      params = args.drop(1)
+
+      if params.any?
+        args[0].public_send(method, params)
       else
-        args[0].send(method)
+        args[0].public_send(method)
       end
     end
   end

data/lib/repositor/instance_allow.rb

@@ -0,0 +1,10 @@
+module Repositor
+  module InstanceMethodsFilter
+    attr_reader :allowed_methods
+
+    # Define which methods only will be allowed to resend to model instance
+    def allow_instance_methods(*methods)
+      @allowed_methods = methods
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: repositor
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Volodya Sveredyuk
@@ -74,6 +74,7 @@ files:
 - lib/generators/repos_generator.rb
 - lib/repositor.rb
 - lib/repositor/active_record.rb
+- lib/repositor/instance_allow.rb
 homepage: https://github.com/sveredyuk/repositor
 licenses:
 - MIT
@@ -94,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Implementation of Repository Pattern for Rails