lazy_crud 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd3014b37d04ad90643b0d6a76b4226ff6744d95
-  data.tar.gz: 570152da372dbb3901ff85ea3d31f6a50b6e5177
+  metadata.gz: 8947aabdd399ff631d4880d675bce69adf90a9cf
+  data.tar.gz: f134362d5c4ef9323bffe84aaa63d92cf95c0465
 SHA512:
-  metadata.gz: 97e86b3f77c7539212b949b6ce4961f61fa1bc871e3421aa402f8f988b5a0a2feb2fe18134978e18ab164741a81f82133371b80b6e65d753f97d8e33f7d7ddc8
-  data.tar.gz: abf440e50d917d27016ba78fbe04fe374301c3638ed542cf78a1d408426a77e25e38f5f6597c9f85af074065e69f536f28aee041086d7aba50504c7391b3d340
+  metadata.gz: c7e2ed7c6f56685fd07c097bc79c2b34d366715d622aab424560a7ceb6e007da961d1ccd0b815def8cc7d1c908d43ee50e4cabe42de09f384cf963208eb8da73
+  data.tar.gz: 0710b4bf1144a3ecda181050e8e8db5da0a1575425d6f1bb4d5eec21b1c779c434ee247c3f4d74a999fd5b8f0f35d3ead811df086d81c0bed16f2eeb7309a8c9

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    lazy_crud (0.9.4)
+    lazy_crud (0.9.5)
       activesupport
       i18n
+      responders
 
 GEM
   remote: https://rubygems.org/
@@ -111,6 +112,8 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.4.2)
+    responders (2.1.0)
+      railties (>= 4.2.0, < 5)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)

data/README.md

@@ -14,12 +14,11 @@ Lazy way to implement common actions in controllers in Rails
 
  - Minimal Controller Coding
  - Resource Can be Scoped to Parent Resource
-
-### TODO
-
- - Generic Error Handeling
- - i18n
- - lambdas and procs for inserting custom behavior
+ - Uses the [responders](https://github.com/plataformatec/responders) gem
+   - Enables i18n on flash messages
+   - Defaultily enables html and json response types
+     - Good for rails apps with an api and / or transitioning to a js framework
+   - Responders is a great gem with lots of flexibility. Be sure to check it out.
 
 ## Installation
 

data/lazy_crud.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0'
 
   s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency "responders"
   s.add_runtime_dependency "i18n"
 
   # for testing a gem with a rails app (controller specs)

data/lib/lazy_crud/before_hook_methods.rb

@@ -0,0 +1,23 @@
+module LazyCrud
+  module BeforeHookMethods
+    include Constants
+
+    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
+  end
+end

data/lib/lazy_crud/class_methods.rb

@@ -0,0 +1,35 @@
+module LazyCrud
+  module ClassMethods
+    include Constants
+
+    # all REST actions will take place on an instance of this class
+    def set_resource(klass)
+      self.resource_class = klass
+    end
+
+    # for scoping the resource
+    # useful for nested routes, such as
+    # /event/:event_id/package/:package_id
+    # where Event would be the parent class and would scope
+    # the package
+    def set_resource_parent(klass)
+      self.parent_class = klass
+    end
+
+    # the list of parameters to allow through the strong parameter filter
+    def set_param_whitelist(*param_list)
+      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
+end

data/lib/lazy_crud/constants.rb

@@ -0,0 +1,7 @@
+module LazyCrud
+  module Constants
+
+    ACTIONS_WITH_HOOKS = [:create, :update, :destroy]
+
+  end
+end

data/lib/lazy_crud/instance_methods.rb

@@ -0,0 +1,153 @@
+module LazyCrud
+  module InstanceMethods
+
+    def index
+      respond_with(set_collection_instance)
+    end
+
+    def show
+      # instance variable set in before_action
+      respond_with(get_resource_instance)
+    end
+
+    def new
+      set_resource_instance(resource_proxy.new)
+      respond_with(get_resource_instance)
+    end
+
+    def edit
+      # instance variable set in before_action
+    end
+
+    def create
+      @resource = resource_proxy.send(build_method, resource_params)
+
+      # ensure we can still use model name-based instance variables
+      # such as @discount, or @event
+      set_resource_instance
+
+      run_before_create_hooks
+
+      flash[:notice] = "#{resource_name} has been created." if @resource.save
+      respond_with(@resource, location: { action: :index })
+      # if @resource.save
+      #   flash[:notice] = "#{resource_name} has been created."
+      #   redirect_to action: :index
+      # else
+      #   render action: :new
+      # end
+    end
+
+    def update
+      run_before_update_hooks
+
+      @resource.update(resource_params)
+      respond_with(@resource, location: { action: :index })
+      # if @resource.update(resource_params)
+      #   redirect_to action: :index
+      # else
+      #   redirect_to action: :edit
+      # end
+    end
+
+    def destroy
+      run_before_destroy_hooks
+      @resource.destroy
+
+      respond_with(@resource, location: { action: :index })
+      # flash[:notice] = "#{resource_name} has been deleted."
+      # redirect_to action: :index
+    end
+
+    # only works if deleting of resources occurs by setting
+    # the deleted_at field
+    def undestroy
+      @resource = resource_proxy(true).find(params[:id])
+      set_resource_instance
+
+      @resource.deleted_at = nil
+      @resource.save
+
+      respond_with(@resource, location: { action: :index })
+
+      # flash[:notice] = "#{resource_name} has been undeleted"
+      # redirect_to action: :index
+    end
+
+    private
+
+    def resource_name
+      @resource.try(:name) || @resource.class.name
+    end
+
+    def set_resource
+      @resource = resource_proxy.find(params[:id])
+    end
+
+    # use .try() on the params hash, in case the user forgot to provide
+    # the attributes
+    def resource_params
+      params[resource_singular_name].try(:permit, self.class.param_whitelist)
+    end
+
+    # determines if we want to use the parent class if available or
+    # if we just use the resource class
+    def resource_proxy(with_deleted = false)
+      proxy = if parent_instance.present?
+        parent_instance.send(resource_plural_name)
+      else
+        self.class.resource_class
+      end
+
+      if with_deleted and proxy.respond_to?(:with_deleted)
+        proxy = proxy.with_deleted
+      end
+
+      proxy
+    end
+
+    # if the resource_proxy has a parent, we can use the
+    # build method. Otherwise, resource_proxy, is just the
+    # resource's class - in which case we'll use new
+    def build_method
+      resource_proxy.respond_to?(:build) ? :build : :new
+    end
+
+    # allows all of our views to still use things like
+    # @level, @event, @whatever
+    # rather than just @resource
+    def set_resource_instance(resource = @resource)
+      instance_variable_set("@#{resource_singular_name}", resource)
+    end
+
+    def get_resource_instance
+      instance_variable_get("@#{resource_singular_name}")
+    end
+
+    # sets the plural instance variable for a collection of objects
+    def set_collection_instance
+      instance_variable_set("@#{resource_plural_name}", resource_proxy)
+    end
+
+    def parent_instance
+      if (not @parent) and self.class.parent_class.present?
+        # e.g.: Event => 'event'
+        parent_instance_name = self.class.parent_class.name.underscore
+        @parent = instance_variable_get("@#{parent_instance_name}")
+      end
+
+      @parent
+    end
+
+    # e.g.: Event => 'events'
+    def resource_plural_name
+      @association_name ||= self.class.resource_class.name.tableize
+    end
+
+    # e.g.: Event => 'event'
+    # alternatively, @resource.class.name.underscore
+    def resource_singular_name
+      @singular_name ||= resource_plural_name.singularize
+    end
+  end
+end

data/lib/lazy_crud/version.rb

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

data/lib/lazy_crud.rb

@@ -1,13 +1,27 @@
 require 'active_support'
 
 require 'lazy_crud/version'
+require 'lazy_crud/constants'
+require 'lazy_crud/before_hook_methods'
+require 'lazy_crud/class_methods'
+require 'lazy_crud/instance_methods'
+
+require 'responders'
+require 'responders/json_responder'
 
 module LazyCrud
   extend ActiveSupport::Concern
 
-  ACTIONS_WITH_HOOKS = [:create, :update, :destroy]
+  include Constants
+  include BeforeHookMethods
+  include InstanceMethods
 
   included do
+    # support buth rails view layer, and js framework
+    respond_to :html, :json
+    # uses custom json responder
+    responders :json
+
     class_attribute :resource_class
     class_attribute :parent_class
     class_attribute :param_whitelist
@@ -21,189 +35,4 @@ module LazyCrud
     before_action :set_resource_instance, only: [:show, :edit, :update, :destroy]
   end
 
-  module ClassMethods
-
-    # all REST actions will take place on an instance of this class
-    def set_resource(klass)
-      self.resource_class = klass
-    end
-
-    # for scoping the resource
-    # useful for nested routes, such as
-    # /event/:event_id/package/:package_id
-    # where Event would be the parent class and would scope
-    # the package
-    def set_resource_parent(klass)
-      self.parent_class = klass
-    end
-
-    # the list of parameters to allow through the strong parameter filter
-    def set_param_whitelist(*param_list)
-      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
-    set_collection_instance
-  end
-
-  def show
-    # instance variable set in before_action
-  end
-
-  def new
-    set_resource_instance(resource_proxy.new)
-  end
-
-  def edit
-    # instance variable set in before_action
-  end
-
-  def create
-    @resource = resource_proxy.send(build_method, resource_params)
-
-    # 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
-    else
-      render action: :new
-    end
-  end
-
-  def update
-    run_before_update_hooks
-    if @resource.update(resource_params)
-      redirect_to action: :index
-    else
-      redirect_to action: :edit
-    end
-  end
-
-  def destroy
-    run_before_destroy_hooks
-    @resource.destroy
-
-    flash[:notice] = "#{resource_name} has been deleted."
-    redirect_to action: :index
-  end
-
-  # only works if deleting of resources occurs by setting
-  # the deleted_at field
-  def undestroy
-    @resource = resource_proxy(true).find(params[:id])
-    set_resource_instance
-
-    @resource.deleted_at = nil
-    @resource.save
-
-    flash[:notice] = "#{resource_name} has been undeleted"
-    redirect_to action: :index
-  end
-
-  private
-
-  def resource_name
-    @resource.try(:name) || @resource.class.name
-  end
-
-  def set_resource
-    @resource = resource_proxy.find(params[:id])
-  end
-
-  # use .try() on the params hash, in case the user forgot to provide
-  # the attributes
-  def resource_params
-    params[resource_singular_name].try(:permit, self.class.param_whitelist)
-  end
-
-  # determines if we want to use the parent class if available or
-  # if we just use the resource class
-  def resource_proxy(with_deleted = false)
-    proxy = if parent_instance.present?
-      parent_instance.send(resource_plural_name)
-    else
-      self.class.resource_class
-    end
-
-    if with_deleted and proxy.respond_to?(:with_deleted)
-      proxy = proxy.with_deleted
-    end
-
-    proxy
-  end
-
-  # if the resource_proxy has a parent, we can use the
-  # build method. Otherwise, resource_proxy, is just the
-  # resource's class - in which case we'll use new
-  def build_method
-    resource_proxy.respond_to?(:build) ? :build : :new
-  end
-
-  # allows all of our views to still use things like
-  # @level, @event, @whatever
-  # rather than just @resource
-  def set_resource_instance(resource = @resource)
-    instance_variable_set("@#{resource_singular_name}", resource)
-  end
-
-  # sets the plural instance variable for a collection of objects
-  def set_collection_instance
-    instance_variable_set("@#{resource_plural_name}", resource_proxy)
-  end
-
-  def parent_instance
-    if (not @parent) and self.class.parent_class.present?
-      # e.g.: Event => 'event'
-      parent_instance_name = self.class.parent_class.name.underscore
-      @parent = instance_variable_get("@#{parent_instance_name}")
-    end
-
-    @parent
-  end
-
-  # e.g.: Event => 'events'
-  def resource_plural_name
-    @association_name ||= self.class.resource_class.name.tableize
-  end
-
-  # e.g.: Event => 'event'
-  # alternatively, @resource.class.name.underscore
-  def resource_singular_name
-    @singular_name ||= resource_plural_name.singularize
-  end
-
 end

data/lib/responders/json_responder.rb

@@ -0,0 +1,16 @@
+# http://stackoverflow.com/questions/9953887
+module Responders::JsonResponder
+  protected
+
+  # simply render the resource even on POST instead of redirecting for ajax
+  def api_behavior
+    if post?
+      display resource, :status => :created
+    # render resource instead of 204 no content
+    elsif put? || delete?
+      display resource, :status => :ok
+    else
+      super
+    end
+  end
+end

data/spec/integration/discounts_controller_spec.rb

@@ -9,12 +9,23 @@ describe DiscountsController, type: :controller do
   end
 
   describe '#index' do
-    it 'sets the collection' do
+    before(:each) do
       create(:discount, event: @event)
+    end
+
+    it 'sets the collection' do
       get :index, event_id: @event.id
 
       expect(assigns(:discounts)).to be_present
     end
+
+    it 'returns json' do
+      get :index, event_id: @event.id, format: :json
+
+      expect{
+        JSON.parse(response.body)
+      }.to_not raise_error
+    end
   end
 
   describe '#show' do
@@ -25,6 +36,15 @@ describe DiscountsController, type: :controller do
 
       expect(assigns(:discount)).to eq discount
     end
+
+    it 'returns json' do
+      discount = create(:discount, event: @event)
+      get :show, event_id: @event.id, id: discount.id, format: :json
+
+      expect{
+        JSON.parse(response.body)
+      }.to_not raise_error
+    end
   end
 
   describe '#new' do
@@ -33,11 +53,18 @@ describe DiscountsController, type: :controller do
 
       expect(assigns(:discount)).to be_new_record
     end
+
+    it 'returns json' do
+      get :new, event_id: @event.id, format: :json
+
+      expect{
+        JSON.parse(response.body)
+      }.to_not raise_error
+    end
   end
 
   describe '#edit' do
 
-
     it 'sets the instance of the object' do
       discount = create(:discount, event: @event)
       get :edit, event_id: @event.id, id: discount.id
@@ -53,6 +80,14 @@ describe DiscountsController, type: :controller do
 
       expect(assigns(:discount)).to be_present
     end
+
+    it 'returns json' do
+      post :create, event_id: @event.id, discount: build(:discount).attributes, format: :json
+
+      expect{
+        JSON.parse(response.body)
+      }.to_not raise_error
+    end
   end
 
   describe '#update' do
@@ -64,6 +99,16 @@ describe DiscountsController, type: :controller do
       field = assigns(:discount)
       expect(field.name).to eq "updated"
     end
+
+    it 'returns json' do
+      discount = create(:discount, event: @event)
+      put :update, event_id: @event.id, id: discount.id,
+        discount: { name: "updated" }, format: :json
+
+      expect{
+        JSON.parse(response.body)
+      }.to_not raise_error
+    end
   end
 
 
@@ -77,6 +122,15 @@ describe DiscountsController, type: :controller do
 
       expect(assigns(:discount).deleted_at).to be_present
     end
+
+    it 'returns json' do
+      discount = create(:discount, event: @event)
+      delete :destroy, event_id: @event.id, id: discount.id, format: :json
+
+      expect{
+        JSON.parse(response.body)
+      }.to_not raise_error
+    end
   end
 
 
@@ -87,9 +141,17 @@ describe DiscountsController, type: :controller do
       expect{
         post :undestroy, event_id: @event.id, id: discount.id
       }.to change(@event.discounts, :count).by 1
-
       expect(assigns(:discount)).to be_present
     end
+
+    it 'returns json' do
+      discount = create(:discount, event: @event, deleted_at: Time.now)
+      post :undestroy, event_id: @event.id, id: discount.id, format: :json
+
+      expect{
+        JSON.parse(response.body)
+      }.to_not raise_error
+    end
   end
 
 

data/spec/support/rails_app/config/application.rb

@@ -5,6 +5,9 @@ require 'rails/all'
 
 require 'lazy_crud'
 require 'paranoia'
+# this would normally be included in the gemfile as
+# a dependency of lazy_crud
+require 'responders'
 
 # Require the gems listed in Gemfile, including any gems
 # you've limited to :test, :development, or :production.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy_crud
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - L. Preston Sego III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-11 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -192,10 +206,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- config/locales/en.yml
 - lazy_crud.gemspec
 - lib/lazy_crud.rb
+- lib/lazy_crud/before_hook_methods.rb
+- lib/lazy_crud/class_methods.rb
+- lib/lazy_crud/constants.rb
+- lib/lazy_crud/instance_methods.rb
 - lib/lazy_crud/version.rb
+- lib/responders/json_responder.rb
 - spec/integration/discounts_controller_spec.rb
 - spec/integration/events_controller_spec.rb
 - spec/integration/users_controller_spec.rb
@@ -298,7 +316,7 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: LazyCrud-0.9.4
+summary: LazyCrud-0.9.5
 test_files:
 - spec/integration/discounts_controller_spec.rb
 - spec/integration/events_controller_spec.rb

data/config/locales/en.yml

@@ -1,11 +0,0 @@
-en:
-  lazy_crud:
-    crud:
-      success:
-        create: ''
-        update: ''
-        destroy: ''
-      failure:
-        create: ''
-        update: ''
-        destroy: ''