crud_responder 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e8a51bb6c0fefbc54ff8893f51eace63e06842b
+  data.tar.gz: 9e361cc28d3daf1f03085189023d0c99053eb76e
+SHA512:
+  metadata.gz: 663c616cbb37453a9f7bb08e2b781f1c85a65b7466f1d16a0b222590633f119cc0033fb1a1a99650d5da03d91be261557c988106867865dc014b1f607546bd8d
+  data.tar.gz: 55a66aee9c7d40564eac7463fa7fcb00ad2c45474c7204a22c82e4bb0f2e51b750dca3470c7b76fd607931a6bb65c05505dc7bafffddb38d53bf74015b50d6ee

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  RunRailsCops: true
+
+  Exclude:
+    - '*.gemspec'
+    - 'bin/*'
+    - 'Rakefile'
+
+Metrics/LineLength:
+  Max: 160
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in crud_responder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Oleg Antonyan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,190 @@
+# CrudResponder
+
+### Embrace CRUD interface for your models
+
+We should keep controllers skinny and don't repeat ourself, right? But this scaffolded action doesn't look very DRY:
+```ruby
+def create
+  @post = Post.new(post_params)
+
+  respond_to do |format|
+    if @post.save
+      format.html { redirect_to @post, notice: 'Post was successfully created.' }
+      format.json { render :show, status: :created, location: @post }
+    else
+      format.html { render :new }
+      format.json { render json: @post.errors, status: :unprocessable_entity }
+    end
+  end
+end
+```
+You can make it simpler if you don't need to respond to anything but html, or use  [`responders`](https://github.com/plataformatec/responders) gem.
+
+Let's assume we need only html and also add flash message on error:
+```ruby
+def create
+  @post = Post.new(post_params)
+
+  if @post.save
+    redirect_to @post, notice: 'Post was successfully updated.' }
+  else
+    flash[:alert] = "Error updating post: #{@post.errors.full_messages.to_sentence}"
+    render :edit
+  end
+end
+```
+But it's still not DRY because we have to repeat this code in every controller, and even a different action of the same controller:
+```ruby
+def update
+  @post = Post.find(params[:id])
+
+  if @post.update(post_params)
+    redirect_to @post, notice: 'Post was successfully created.'
+  else
+    flash[:alert] = "Error creating post: #{@post.errors.full_messages.to_sentence}"
+    render :new
+  end
+end
+```
+But the only differences between these actions are:
+* Method called on a model
+* Action on success
+* Action on error
+* Text in flash message on success
+* Text in flash message on error
+
+And they are repeated over and over again. Let's extract these differences:
+```ruby
+def create
+  @post = Post.new(post_params)
+  crud_respond @post # will call save, set flashes and redirects/render appropriately
+end
+
+def update
+  @post = Post.find(params[:id])
+  @post.assign_attributes(post_params)
+  crud_respond @post # also call save
+end
+
+def destroy
+  @post = Post.find(params[:id])
+  crud_respond @post # call destroy because called from destroy action
+end
+
+```
+Method to call on the object determined by the name of controller's action.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'crud_responder', github: 'olegantonyan/crud_responder'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install crud_responder
+
+## Usage
+
+Include `CrudResponder` into your `ApplicationController` (or whatever base controller you have)
+```ruby
+class ApplicationController
+  include CrudResponder
+end
+```
+
+Use `crud_respond` method with object you need to create, update or destroy. Optionally, you can pass options to this method to override default redirect and render actions
+```ruby
+def create
+  @post = Post.new(post_params)
+  crud_respond @post, success_url: root_path, error_action: :custom_new_action
+  # will redirect to root_path in case of success or render :custom_new_action otherwise
+end
+```
+By default you will be redirected to object show, objects index or back in this order. And render :new when creating object and :edit when updating.
+
+You can specify `error_url` instead of `error_action` to be redirected instead of action render in case of error.
+```ruby
+def create
+  @post = Post.new(post_params)
+  crud_respond @post, success_url: root_path, error_url: 'https://google.com'
+  # will redirect to root_path in case of success or to https://google.com otherwise
+end
+```
+
+You can also specify per-controller default options:
+```ruby
+private
+
+def crud_responder_default_options
+  { success_url: root_path }
+  # will redirect to `root_path` for every successful request in this controller
+end
+```
+
+If  you need to create a bunch of objects (not just one) you can create wrapper class with same interface. For example, uploading multiple files:
+```ruby
+# app/controllers/media_items_controller.rb
+class MediaItemsController < ApplicationController
+  def create_multiple
+    @media_item_multiple = MediaItem::CreateMultiple.new(media_item_create_multiple_params)
+    crud_respond @media_item_multiple, success_url: media_items_path
+  end
+
+  private
+
+  def media_item_create_multiple_params
+    params.require(:media_item_create_multiple).permit(:description, files: [])
+  end
+end
+
+# app/models/media_item/create_multiple.rb
+class MediaItem::CreateMultiple
+  include ActiveModel::Model
+
+  attr_accessor :description, :files
+  validates :files, presence: true
+
+  def save
+    return false unless valid?
+    ActiveRecord::Base.transaction do
+      files.each do |file|
+        MediaItem.create!(description: description,  file: file)
+      end
+    end
+    true
+  rescue ActiveRecord::RecordInvalid => e
+    errors.add(:base, e.to_s)
+    false
+  end
+end
+```
+Now your controllers are skinny again! Also, you are forced to think in terms of CRUD interface to models and REST to controllers.
+
+## TODO
+
+* Cutomizing flash messages (+ task to copy skeleton locale)
+* Support for pure API controllers (which is much simplier)
+* Testing
+* Push to rubygems
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/olegantonyan/crud_responder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "crud_responder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  flash:
+    actions:
+      create:
+        notice: '%{resource_name} %{resource_desc} was successfully created.'
+        alert: '%{resource_name} %{resource_desc} cannot be created. %{errors}'
+      update:
+        notice: '%{resource_name} %{resource_desc} was successfully updated.'
+        alert: '%{resource_name} %{resource_desc} cannot be updated. %{errors}'
+      destroy:
+        notice: '%{resource_name} %{resource_desc} was successfully destroyed.'
+        alert: '%{resource_name} %{resource_desc} cannot be destroyed. %{errors}'

data/config/locales/ru.yml

@@ -0,0 +1,12 @@
+ru:
+  flash:
+    actions:
+      create:
+        notice: '%{resource_name} %{resource_desc} был успешно создан.'
+        alert: '%{resource_name} %{resource_desc} не может быть создан. %{errors}'
+      update:
+        notice: '%{resource_name} %{resource_desc} был успешно обновлён.'
+        alert: '%{resource_name} %{resource_desc} не может быть обновлён. %{errors}'
+      destroy:
+        notice: '%{resource_name} %{resource_desc} был успешно удалён.'
+        alert: '%{resource_name} %{resource_desc} не может быть удалён. %{errors}'

data/crud_responder.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crud_responder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crud_responder"
+  spec.version       = CrudResponder::VERSION
+  spec.authors       = ["Oleg Antonyan"]
+  spec.email         = ["oleg.b.antonyan@gmail.com"]
+
+  spec.summary       = %q{DRY out your controler actions for CRUD operations with flash messages}
+  spec.description   = %q{Don't repeat object.save, object.update, object.destroy and flash[:alert], flash[:notice] in every controller. Use action's name to decide what to do}
+  spec.homepage      = "https://github.com/olegantonyan/crud_responder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_dependency "railties", "~> 4"
+  spec.add_dependency "actionpack", "~> 4"
+end

data/lib/crud_responder/default_options.rb

@@ -0,0 +1,52 @@
+require 'action_dispatch/routing/polymorphic_routes'
+
+module CrudResponder
+  class DefaultOptions
+    include ActionDispatch::Routing::PolymorphicRoutes
+
+    def self.all_available
+      @_all_available ||= new(nil, nil).public_methods(false).map(&:to_sym)
+    end
+
+    def initialize(method, object)
+      @method = method
+      @object = object
+    end
+
+    def success_url
+      if method == :destroy
+        object_index_url
+      else
+        object_url
+      end || :back
+    end
+
+    def error_action
+      if object.persisted?
+        :edit
+      else
+        :new
+      end
+    end
+
+    def error_url
+      nil
+    end
+
+    private
+
+    attr_reader :method, :object
+
+    def object_index_url
+      polymorphic_url(object.class)
+    rescue NoMethodError
+      nil
+    end
+
+    def object_url
+      polymorphic_url(object)
+    rescue NoMethodError
+      nil
+    end
+  end
+end

data/lib/crud_responder/version.rb

@@ -0,0 +1,3 @@
+module CrudResponder
+  VERSION = '0.2.2'
+end

data/lib/crud_responder.rb

@@ -0,0 +1,110 @@
+require 'crud_responder/version'
+require 'crud_responder/default_options'
+require 'action_view/helpers/text_helper'
+
+module CrudResponder
+  include ActionView::Helpers::TextHelper
+
+  protected
+
+  def crud_respond(object, opts = {})
+    method = opts.fetch(:method, method_by_caller(caller))
+    options = final_options(opts, method, object)
+    if perform(caller, object, method)
+      success(options)
+    else
+      error(options)
+    end
+  end
+
+  private
+
+  def success(options)
+    redirect_to options[:success_url]
+  end
+
+  def error(options)
+    if options[:error_url]
+      redirect_to options[:error_url]
+    else
+      render options[:error_action]
+    end
+  end
+
+  def final_options(opts, method, object)
+    @_options ||= begin
+      {}.tap do |result|
+        DefaultOptions.all_available.each do |opt|
+          result[opt] = opts.fetch(opt) { |key| specific_options_for(key) || default_options_for(key, method, object) }
+        end
+      end
+    end
+  end
+
+  def default_options_for(opt, method, object)
+    default_options(method, object).public_send(opt)
+  end
+
+  def default_options(method, object)
+    @_default_options ||= DefaultOptions.new(method, object)
+  end
+
+  def specific_options_for(opt)
+    return nil unless respond_to?(:crud_responder_default_options, true)
+    result = send(:crud_responder_default_options)
+    return nil unless result
+    result.fetch(opt, nil)
+  end
+
+  def caller_name(kaller)
+    kaller[0][/`.*'/][1..-2]
+  end
+
+  def method_by_caller(kaller)
+    if caller_name(kaller) =~ /destroy/
+      :destroy
+    else
+      :save
+    end
+  end
+
+  def perform(kaller, object, method)
+    ok = object.public_send(method)
+    t_key = "flash.actions.#{action_by_caller(kaller)}.#{ok ? 'notice' : 'alert'}"
+    if ok
+      flash_success I18n.t(t_key, resource_name: resource_name_by_object(object), resource_desc: object.to_s)
+    else
+      flash_error I18n.t(t_key, resource_name: resource_name_by_object(object), resource_desc: object.to_s, errors: object.errors.full_messages.to_sentence)
+    end
+    ok
+  end
+
+  def action_by_caller(kaller)
+    case caller_name(kaller)
+    when /destroy/
+      :destroy
+    when /update/
+      :update
+    when /create/
+      :create
+    else
+      "unknown_action_from_#{caller_name(kaller)}".to_sym
+    end
+  end
+
+  def resource_name_by_object(object)
+    object.class.to_s
+  end
+
+  def flash_success(msg)
+    flash[:notice] = truncate_message(msg)
+  end
+
+  def flash_error(msg)
+    flash[:alert] = truncate_message(msg)
+  end
+
+  def truncate_message(msg)
+    truncate(msg.to_s, length: 256, escape: false)
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: crud_responder
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Oleg Antonyan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Don't repeat object.save, object.update, object.destroy and flash[:alert],
+  flash[:notice] in every controller. Use action's name to decide what to do
+email:
+- oleg.b.antonyan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/locales/en.yml
+- config/locales/ru.yml
+- crud_responder.gemspec
+- lib/crud_responder.rb
+- lib/crud_responder/default_options.rb
+- lib/crud_responder/version.rb
+homepage: https://github.com/olegantonyan/crud_responder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: DRY out your controler actions for CRUD operations with flash messages
+test_files: []