batch_actions 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e68fc1158fbe9d59d7e11c037f3cc580d855e314
+  data.tar.gz: 203625073e57c12ae947b3016283e0eb044339af
+SHA512:
+  metadata.gz: b397f3158bfc0e7e9f0d5a4072922804c2c197f51eeaa52604b4589a73324497dafc6c5a5f0d4d0aeb476ecd6e3aef6cb8d100f91bbbde4e0274108cd8f207f6
+  data.tar.gz: e1db247358fb5e19eccb1322217de7f0a73ee49b79645555fc3f978ec577e5a606a8bea5a3ff1c1b3a0eb089fbb306ddd7d9ed48f7d60eb66444d8abe5659e7d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--tty --colour

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in batch_actions.gemspec
+gemspec
+
+gem 'rspec'
+gem 'rake'
+gem 'simplecov'
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sergey Gridasov
+
+MIT License
+
+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,58 @@
+# BatchActions
+
+This gem adds generic support for batch actions to Rails controllers.
+
+[![Travis CI](https://secure.travis-ci.org/grindars/batch_actions.png)](https://travis-ci.org/grindars/batch_actions)
+[![Code Climate](https://codeclimate.com/github/grindars/batch_actions.png)](https://codeclimate.com/github/grindars/batch_actions)
+
+Sponsored by [Evil Martians](http://evilmartians.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'batch_actions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install batch_actions
+
+## Usage
+
+```ruby
+class PostController < ApplicationController
+  include BatchActions
+
+  batch_model Post
+
+  # Runs `model.publish` for every model from params[:ids]
+  batch_action :publish
+
+  # Runs `model.destroy` for every model from params[:ids] or throws exception unless you can
+  batch_action :destroy, if: ->() { can? :destroy, Post }
+
+  # Runs block for every model from params[:ids]
+  batch_action :specific do |objects|
+    objects.each{|x| x.specific!}
+  end
+
+  # Runs `model.resurrect` for every model from returned relation
+  batch_action :resurrect, :scope => ->(ids) { Post.where(other_ids: ids) }
+end
+```
+
+Note that you can omit `batch_model` call if you use the [inherited_resources](https://github.com/josevalim/inherited_resources) gem. It grabs your model class from `resource_class`.
+
+There's one more important thing to know: set of active batch actions can be retrieved from controller by calling `batch_actions` on controller instance.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/batch_actions.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'batch_actions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "batch_actions"
+  spec.version       = BatchActions::VERSION
+  spec.authors       = ["Sergey Gridasov"]
+  spec.email         = ["grindars@gmail.com"]
+  spec.description   = %q{Batch action support for Rails.}
+  spec.summary       = %q{Batch action support for Rails.}
+  spec.homepage      = "https://github.com/grindars/batch_actions"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

data/lib/batch_actions.rb

@@ -0,0 +1,36 @@
+require "batch_actions/version"
+require "batch_actions/class_methods"
+
+module BatchActions
+  def batch_actions
+    return [] unless self.class.instance_variable_defined? :@batch_actions
+
+    actions = self.class.instance_variable_get :@batch_actions
+    allowed = []
+
+    actions.each do |keyword, condition|
+      if instance_exec(&condition)
+        allowed << keyword
+      end
+    end
+
+    allowed
+  end
+
+  def batch_action
+    action = params[:name]
+
+    raise "action is not allowed" unless batch_actions.include? action.to_sym
+
+    send(:"batch_#{action}")
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+
+    if defined?(InheritedResources::Base) &&
+       base < InheritedResources::Base
+      base.batch_model base.resource_class
+    end
+  end
+end

data/lib/batch_actions/class_methods.rb

@@ -0,0 +1,60 @@
+module BatchActions
+  module ClassMethods
+    def batch_model(klass)
+      @batch_model = klass
+    end
+
+    def batch_action(keyword, opts = {}, &block)
+      @batch_actions = {} if @batch_actions.nil?
+
+      if opts.include? :model
+        model = opts[:model]
+      elsif !@batch_model.nil?
+        model = @batch_model
+      else
+        raise ArgumentError, "model must be specified"
+      end
+
+      if block_given?
+        apply = block
+      else
+        apply = ->(objects) do
+          objects.each do |object|
+            object.send(keyword)
+          end
+        end
+      end
+
+      if opts.include? :scope
+        scope = opts[:scope]
+      else
+        scope = ->(model) do
+          model.where(:id => params[:ids])
+        end
+      end
+
+      if opts.include? :if
+        condition = opts[:if]
+      else
+        condition = ->() do
+          if self.respond_to? :can?
+            can? keyword, model
+          else
+            true
+          end
+        end
+      end
+
+      @batch_actions[keyword] = condition
+
+      define_method(:"batch_#{keyword}") do
+        result = instance_exec(&condition)
+
+        raise "action is not allowed" unless result
+
+        objects = instance_exec(model, &scope)
+        apply.call(objects)
+      end
+    end
+  end
+end

data/lib/batch_actions/version.rb

@@ -0,0 +1,3 @@
+module BatchActions
+  VERSION = "0.0.1"
+end

data/spec/batch_actions_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+describe BatchActions do
+  it "generates batch actions" do
+    ctrl = mock_controller(
+      :ids => [ 1, 2 ]
+    ) do
+      batch_model TestModel
+      batch_action :test1
+    end
+
+    times = 0
+
+    TestModel.should_receive(:where).with({ :id => [ 1, 2 ]}).and_call_original
+    TestModel.any_instance.stub(:test1) { times += 1 }
+
+    ctrl.batch_test1
+
+    times.should == 2
+  end
+
+  it "requires a model to be specified" do
+    expect do
+      mock_controller do
+        batch_action :test1
+      end
+    end.to raise_error(ArgumentError)
+  end
+
+  it "allows per-action override of a model" do
+    ctrl = mock_controller(
+      :ids => [ 1 ]
+    ) do
+      batch_model TestModel
+
+      batch_action :test1
+      batch_action :test2, :model => TestModel2
+    end
+
+    TestModel.should_receive(:where).with({ :id => [ 1 ]}).and_call_original
+    TestModel2.should_receive(:where).with({ :id => [ 1 ]}).and_call_original
+
+    TestModel.any_instance.should_receive(:test1).and_return(nil)
+    TestModel2.any_instance.should_receive(:test2).and_return(nil)
+
+    ctrl.batch_test1
+    ctrl.batch_test2
+  end
+
+  it "allows to specify scope" do
+    scope_called = false
+
+    instance = TestModel.new
+    instance.should_receive(:test1).and_return(nil)
+
+    ctrl = mock_controller(
+      :ids => [ 1 ]
+    ) do
+      batch_model TestModel
+
+      batch_action :test1, :scope => ->(model) do
+        scope_called = true
+
+        [ instance ]
+      end
+    end
+
+    ctrl.batch_test1
+
+    scope_called.should be_true
+  end
+
+  it "allows to override default apply" do
+    block_called = nil
+
+    ctrl = mock_controller(
+      :ids => [ 1 ]
+    ) do
+      batch_model TestModel
+
+      batch_action(:test1) do |objects|
+        block_called = objects
+      end
+    end
+
+    ctrl.batch_test1
+
+    block_called.should_not be_nil
+    block_called.length.should == 1
+  end
+
+  it "supports :if" do
+    ctrl = mock_controller(
+      :ids => [ 1 ]
+    ) do
+      batch_model TestModel
+
+      batch_action :test, :if => ->() { false }
+    end
+
+    expect { ctrl.batch_test1 }.to raise_error
+    ctrl.batch_actions.should be_empty
+  end
+
+  it "implements batch_actions" do
+    ctrl = mock_controller do
+      batch_model TestModel
+
+      batch_action :test1
+      batch_action :test2
+      batch_action :test3, :if => ->() { false }
+    end
+
+    ctrl.batch_actions.should == [ :test1, :test2 ]
+  end
+
+  it "supports InheritedResources" do
+    expect do
+      mock_controller(:parent => InheritedResources::Base) do
+        batch_action :test1
+      end
+    end.to_not raise_error
+  end
+
+  it "supports CanCan" do
+    ctrl = mock_controller do
+      batch_model TestModel
+
+      batch_action :test1
+      batch_action :test2
+
+      def can?(keyword, model)
+        keyword == :test1
+      end
+    end
+
+    ctrl.batch_actions.should == [ :test1 ]
+  end
+
+  it "implements batch_action" do
+    [ "test1", "test2" ].each do |action|
+      ctrl = mock_controller(
+        :ids => [ 1 ],
+        :name => action
+      ) do
+        batch_model TestModel
+        batch_action :test1
+        batch_action :test2
+      end
+
+      TestModel.any_instance.should_receive(action.to_sym).and_return(nil)
+      ctrl.batch_action
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'batch_actions'
+
+class TestModel
+  def self.where(query)
+    query[:id].map { self.new }
+  end
+end
+
+class TestModel2
+  def self.where(query)
+    query[:id].map { self.new }
+  end
+end
+
+module InheritedResources
+  class Base
+    def self.resource_class
+      TestModel
+    end
+  end
+end
+
+def mock_controller(params = {}, &block)
+  parent = params.delete(:parent) || Object
+
+  mock_class = Class.new(parent) do
+    include BatchActions
+
+    def params
+      self.class.instance_variable_get :@params
+    end
+  end
+
+  mock_class.class_exec(&block)
+  mock_class.instance_variable_set :@params, params
+
+  mock_class.new
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: batch_actions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Gridasov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Batch action support for Rails.
+email:
+- grindars@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- batch_actions.gemspec
+- lib/batch_actions.rb
+- lib/batch_actions/class_methods.rb
+- lib/batch_actions/version.rb
+- spec/batch_actions_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/grindars/batch_actions
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Batch action support for Rails.
+test_files:
+- spec/batch_actions_spec.rb
+- spec/spec_helper.rb