lazy_crud 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32871f8c7fcf29804cba0f25c3ab1fa585cf0516
-  data.tar.gz: af379a9727d4b46fe0451da95a133512f04ff925
+  metadata.gz: fd3014b37d04ad90643b0d6a76b4226ff6744d95
+  data.tar.gz: 570152da372dbb3901ff85ea3d31f6a50b6e5177
 SHA512:
-  metadata.gz: d23a9e140f80b25061906919c41bb190927b29d7658e3b619545baf2fade1958d0b36c6ec3f297d184591d7aff33bc369992b7959dd5cbf33ef19e0e760a2a37
-  data.tar.gz: 556c8e9fe7e60af0ade37b871e2bca0b783e14252821a6bb8a0c21dcb498fdc4bd223b026485428b5c9e280e250872d1f914c277bad95a1c5dce4ef042713705
+  metadata.gz: 97e86b3f77c7539212b949b6ce4961f61fa1bc871e3421aa402f8f988b5a0a2feb2fe18134978e18ab164741a81f82133371b80b6e65d753f97d8e33f7d7ddc8
+  data.tar.gz: abf440e50d917d27016ba78fbe04fe374301c3638ed542cf78a1d408426a77e25e38f5f6597c9f85af074065e69f536f28aee041086d7aba50504c7391b3d340

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lazy_crud (0.9.2)
+    lazy_crud (0.9.4)
       activesupport
       i18n
 

data/README.md

@@ -1,4 +1,5 @@
-# lazy_crud
+# lazy_crud [![Join the chat at https://gitter.im/NullVoxPopuli/lazy_crud](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/NullVoxPopuli/lazy_crud?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 Lazy way to implement common actions in controllers in Rails
 
 [![docs](https://img.shields.io/badge/docs-yardoc-blue.svg?style=flat-square)](http://www.rubydoc.info/github/NullVoxPopuli/lazy_crud)
@@ -35,31 +36,61 @@ Terminal
 
 ### Basic setup
 
+Include all of the basic actions, `create`, `edit`, `destroy`, etc
+
     class SomeObjectController < ApplicationController
       include LazyCrud
 
-      # At a bare minimum, you'll need to specify the
-      # class the controller is acting upon.
+At a bare minimum, you'll need to specify the class the controller is acting upon.
+
       set_resource SomeObject
 
-      # optional
-      # this is for in the case of you having nested routes, and want to scope
-      # SomeObject to its parent object.
-      # For example: /event/:event_id/discounts/:id
-      # Event is the parent object and Discount is the resource
-      #
-      # Note that there must be an @event instance variable set
-      #
-      # See specs for details
+
+**Optional**
+
+This is for in the case of you having nested routes, and want to scope
+`SomeObject` to its parent object.
+
+For example: `/event/:event_id/discounts/:id`
+Event is the parent object and Discount is the resource
+
+Note that there must be an `@event` instance variable set.
+See specs for details.
+
       set_resource_parent Event
 
-      # sort of optional
-      # if you want to be able to update / create objects, you'll want to
-      # specify what parameters are allowed to be set.
-      # this uses strong parameters
+**Sort of Optional**
+
+If you want to be able to update / create objects, you'll want to
+specify what parameters are allowed to be set.
+This uses strong parameters.
+
       set_param_whitelist(:name, :amount)
+
+      # ... other controller stuff
     end
 
+
+### CRUD-hooks
+
+Sometimes you may want to manually assign attributes to an object before saving, such as current_user.
+
+There are two ways to do this:
+
+    def before_create
+      @resource.user = current_user
+    end
+
+or if you are wanting to have ruby throw an error if you spelled something wrong
+
+    before_create ->(resource){ resource.user = current_user }
+
+the error thrown will be NoMethodError
+
+Available CRUD-hooks are: `before_create`, `before_update`, `before_destroy`
+
+Each hook can be called multiple times, and they will be invoked in the order they were defined. If the `def` method is used, it will be invoked last.
+
 ## Contributing
 
 1. Fork the project

data/lib/lazy_crud/version.rb

@@ -1,3 +1,3 @@
 module LazyCrud
-  VERSION = "0.9.3"
+  VERSION = "0.9.4"
 end

data/lib/lazy_crud.rb

@@ -5,11 +5,18 @@ require 'lazy_crud/version'
 module LazyCrud
   extend ActiveSupport::Concern
 
+  ACTIONS_WITH_HOOKS = [:create, :update, :destroy]
+
   included do
     class_attribute :resource_class
     class_attribute :parent_class
     class_attribute :param_whitelist
 
+    # crud hooks
+    class_attribute :before_create_hooks
+    class_attribute :before_update_hooks
+    class_attribute :before_destroy_hooks
+    # setting instance variables for actions and views
     before_action :set_resource, only: [:show, :edit, :update, :destroy]
     before_action :set_resource_instance, only: [:show, :edit, :update, :destroy]
   end
@@ -35,6 +42,35 @@ module LazyCrud
       self.param_whitelist = param_list
     end
 
+    ACTIONS_WITH_HOOKS.each do |action|
+      # adds a lambda to the hook array
+      define_method("before_#{action}") do |func|
+        hook_list = self.send("before_#{action}_hooks")
+        hook_list ||= []
+        hook_list << func
+
+        self.send("before_#{action}_hooks=", hook_list)
+      end
+    end
+
+  end
+
+  ACTIONS_WITH_HOOKS.each do |action|
+    # runs all of the hooks
+    define_method("run_before_#{action}_hooks") do
+      hook_list = self.send("before_#{action}_hooks")
+
+      if hook_list
+        hook_list.each do |hook|
+          hook.call(@resource)
+        end
+      end
+
+      # run the before action method if it exists
+      if respond_to?("before_#{action}")
+        self.send("before_#{action}")
+      end
+    end
   end
 
   def index
@@ -59,6 +95,7 @@ module LazyCrud
     # ensure we can still use model name-based instance variables
     set_resource_instance
 
+    run_before_create_hooks
     if @resource.save
       flash[:notice] = "#{resource_name} has been created."
       redirect_to action: :index
@@ -68,6 +105,7 @@ module LazyCrud
   end
 
   def update
+    run_before_update_hooks
     if @resource.update(resource_params)
       redirect_to action: :index
     else
@@ -76,6 +114,7 @@ module LazyCrud
   end
 
   def destroy
+    run_before_destroy_hooks
     @resource.destroy
 
     flash[:notice] = "#{resource_name} has been deleted."

data/spec/integration/events_controller_spec.rb

@@ -0,0 +1,51 @@
+require 'rails_helper'
+
+describe EventsController, type: :controller do
+
+  describe 'before_create' do
+    it 'has 2 hooks' do
+      hooks = controller.class.before_create_hooks
+      expect(hooks.count).to eq 2
+    end
+
+    it 'calls before_create hooks' do
+
+      expect(controller).to receive(:before_create)
+      post :create, event: build(:event).attributes
+    end
+
+    it 'evaluates the before_create hooks' do
+      attributes = build(:event).attributes
+      post :create, event: attributes
+
+      name = attributes["name"].upcase
+      expected = name + " " + name
+      actual = assigns(:event).name
+      expect(actual).to eq expected
+    end
+  end
+
+  describe 'before_update' do
+
+    it 'calls before_update hooks' do
+      event = create(:event)
+      put :update, id: event.id, event: {}
+      actual = assigns(:event).user_id
+      expect(actual).to eq -1
+    end
+
+  end
+
+  describe 'before_destroy' do
+
+    it 'calls before_destroy hooks' do
+      event = create(:event)
+      expect(event.created_at).to_not eq nil
+      delete :destroy, id: event.id
+      expect(assigns(:event).created_at).to eq nil
+
+    end
+  end
+
+
+end

data/spec/support/rails_app/app/controllers/events_controller.rb

@@ -1,58 +1,18 @@
 class EventsController < ApplicationController
-  before_action :set_event, only: [:show, :edit, :update, :destroy]
+  include LazyCrud
 
-  # GET /events
-  def index
-    @events = Event.all
-  end
-
-  # GET /events/1
-  def show
-  end
-
-  # GET /events/new
-  def new
-    @event = Event.new
-  end
+  set_resource Event
+  set_param_whitelist(:name)
 
-  # GET /events/1/edit
-  def edit
-  end
-
-  # POST /events
-  def create
-    @event = Event.new(event_params)
+  before_create ->(resource){ resource.name = resource.name.upcase }
+  before_create ->(resource){}
 
-    if @event.save
-      redirect_to @event, notice: 'Event was successfully created.'
-    else
-      render :new
-    end
-  end
-
-  # PATCH/PUT /events/1
-  def update
-    if @event.update(event_params)
-      redirect_to @event, notice: 'Event was successfully updated.'
-    else
-      render :edit
-    end
-  end
+  before_update ->(resource){ resource.user_id = -1 }
+  before_destroy ->(resource){ resource.created_at = nil }
 
-  # DELETE /events/1
-  def destroy
-    @event.destroy
-    redirect_to events_url, notice: 'Event was successfully destroyed.'
+  def before_create
+    @resource.name = @resource.name + " " + @resource.name
   end
 
-  private
-    # Use callbacks to share common setup or constraints between actions.
-    def set_event
-      @event = Event.find(params[:id])
-    end
 
-    # Only allow a trusted parameter "white list" through.
-    def event_params
-      params[:event]
-    end
 end

data/spec/unit/lazy_crud_spec.rb

@@ -4,6 +4,11 @@ describe LazyCrud do
 
   class Example < ActionController::Base
     include LazyCrud
+
+    before_create -> (resource){ 2+2 }
+    before_update -> (resource){ 2+2 }
+    before_destroy -> (resource){ 2+2 }
+
   end
 
 
@@ -19,4 +24,24 @@ describe LazyCrud do
   end
 
 
+  context 'calling a hook adds it to the hook list' do
+
+    it 'before_create appends to the hook list' do
+      hooks = Example.before_create_hooks
+      expect(hooks.count).to eq 1
+    end
+
+    it 'before_update appends to the hook list' do
+      hooks = Example.before_update_hooks
+      expect(hooks.count).to eq 1
+    end
+
+    it 'before_destroy appends to the hook list' do
+      hooks = Example.before_destroy_hooks
+      expect(hooks.count).to eq 1
+    end
+
+  end
+
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy_crud
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - L. Preston Sego III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-10 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -197,6 +197,7 @@ files:
 - lib/lazy_crud.rb
 - lib/lazy_crud/version.rb
 - spec/integration/discounts_controller_spec.rb
+- spec/integration/events_controller_spec.rb
 - spec/integration/users_controller_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
@@ -297,9 +298,10 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: LazyCrud-0.9.3
+summary: LazyCrud-0.9.4
 test_files:
 - spec/integration/discounts_controller_spec.rb
+- spec/integration/events_controller_spec.rb
 - spec/integration/users_controller_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb