bulky 0.8.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,30 @@
+# Bulky
+
+## Installation
+
+In your Gemfile
+``` ruby
+  gem 'bulky', github: 'adamhunter/bulky'
+```
+
+Then in your shell prompt
+```bash
+  bundle
+  rake bulky_engine:install:migrations
+  rake db:migrate
+  rake bulky:work # (starts the resque worker for bulky)
+```
+
+## Usage
+
+Application
+Add a form in `app/views/bulky/updates/edit.html.haml` to override the one provided.
+
+
+Command Line
+```ruby
+  #                    model,   ids,     arguments for update_attributes!
+  Bulky.enqueue_update(Account, [10,25], {"contact" => "Yes, please."})
+```
+
+This will enqueue the `Bulky::Updater` to update each account when the job is processed by Resque

data/Rakefile

@@ -0,0 +1,28 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Bulky'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/controllers/bulky/updates_controller.rb

@@ -0,0 +1,39 @@
+class Bulky::UpdatesController < ApplicationController
+
+  helper_method :model
+
+  def edit
+  end
+
+  def update
+    if params[:ids].blank?
+      redirect_to bulky_edit_path(model: params[:model]), alert: I18n.t('flash.alert.blank_ids') and return
+    end
+
+    unless params[:bulk].is_a?(Hash)
+      redirect_to bulky_edit_path(model: params[:model]), alert: I18n.t('flash.alert.bulk_not_hash') and return
+    end
+
+    Bulky.enqueue_update(model, ids, params[:bulk])
+    redirect_to bulky_edit_path(model: params[:model]), notice: I18n.t('flash.notice.enqueue_update')
+  end
+
+  private
+
+  def model
+    @model ||= params[:model].classify.constantize
+  end
+  
+  def ids
+    Bulky.parse_ids(params[:ids])
+  end
+
+  def params
+    @params ||= delete_blank(super)
+  end
+
+  def delete_blank(hash)
+    hash.delete_if { |k,v| v.empty? or Hash === v && delete_blank(v).empty? }
+  end
+
+end

data/app/helpers/bulky/form_helper.rb

@@ -0,0 +1,9 @@
+module Bulky
+  module FormHelper
+
+    def whitelisted_attributes_collection(model)
+      model.accessible_attributes.select(&:present?).map {|a| [a.titleize, a]}
+    end
+
+  end
+end

data/app/models/bulky/bulk_update.rb

@@ -0,0 +1,18 @@
+class Bulky::BulkUpdate < ActiveRecord::Base
+  self.table_name = 'bulky_bulk_updates'
+
+  serialize :updates, Hash
+  serialize :ids,     Array
+
+  validates :ids, :updates, presence: true
+
+  has_many :updated_records, class_name: 'Bulky::UpdatedRecord', foreign_key: :bulk_update_id
+
+  validates_each :updates do |record, attr, value|
+    record.errors[:updates] << "must be a hash" unless Hash === value
+  end
+
+  validates_each :ids do |record, attr, value|
+    record.errors[:ids] << "must be an Array" unless Array === value
+  end
+end

data/app/models/bulky/updated_record.rb

@@ -0,0 +1,11 @@
+class Bulky::UpdatedRecord < ActiveRecord::Base
+  self.table_name = 'bulky_updated_records'
+
+  serialize :updatable_changes, Hash
+
+  # updatable_changes can be blank on a mass assignment security violation
+  validates :bulk_update_id, :updatable, presence: true
+
+  belongs_to :bulk_update, class_name: 'Bulky::BulkUpdate', foreign_key: :bulk_update_id
+  belongs_to :updatable, polymorphic: true
+end

data/app/views/bulky/updates/edit.html.haml

@@ -0,0 +1,11 @@
+%h1 Bulky
+
+= form_for :bulk, url: bulky_update_path(model: params[:model]), html: {method: :put} do |f|
+  %p
+    = f.select :attribute, whitelisted_attributes_collection(model), {include_blank: "Choose an Attribute"},
+      name: "attribute", onchange: "document.getElementById('bulk_value').name = 'bulk[' + this.value + ']'"
+    = f.text_field :value
+  %p
+    = f.text_area :ids, name: :ids
+  %p
+    = f.button :submit

data/config/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  flash:
+    notice:
+      enqueue_update: "Bulk updated has been scheduled successfully."
+    alert:
+      blank_ids: "IDs cannot be blank."
+      bulk_not_hash: "Bulk update options are not in a reconized format (must be a hash)."

data/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  namespace :bulky do
+    get ':model/edit', to: 'updates#edit',   as: 'edit'
+    put ':model',      to: 'updates#update', as: 'update'
+  end
+end

data/db/migrate/20120911145530_create_bulky_tables.rb

@@ -0,0 +1,30 @@
+class CreateBulkyTables < ActiveRecord::Migration
+  def up
+    create_table :bulky_bulk_updates, force: true do |t|
+      t.text :ids,     null: false
+      t.text :updates, null: false
+      t.integer :initiated_by_id
+
+      t.timestamps
+    end
+    add_index :bulky_bulk_updates, :initiated_by_id
+
+    create_table :bulky_updated_records, force: true do |t|
+      t.integer :bulk_update_id,    null: false
+      t.integer :updatable_id,      null: false
+      t.string  :updatable_type,    null: false
+      t.text    :updatable_changes, null: false
+      t.string  :error_message
+      t.text    :error_backtrace
+
+      t.timestamps
+    end
+    add_index :bulky_updated_records, :bulk_update_id
+    add_index :bulky_updated_records, [:updatable_type, :updatable_id]
+  end
+
+  def down
+    drop_table :bulky_updated_records
+    drop_table :bulky_bulk_updates
+  end
+end

data/lib/bulky.rb

@@ -0,0 +1,27 @@
+require "bulky/engine"
+
+module Bulky
+  extend self
+  
+  def enqueue_update(model, ids, updates)
+    bulk_update = log_bulk_update(ids, updates)
+
+    ids.each do |update_id|
+      Resque.enqueue(Bulky::Updater, model.name, update_id, bulk_update.id)
+    end
+  end
+
+  def parse_ids(ids)
+    ids.gsub("\n", ',').split(',').map(&:strip).reject(&:blank?)
+  end
+
+  def log_bulk_update(ids, updates)
+    Bulky::BulkUpdate.create! do |bu|
+      bu.ids     = ids
+      bu.updates = updates
+    end
+  end
+
+end
+
+require 'bulky/updater'

data/lib/bulky/engine.rb

@@ -0,0 +1,7 @@
+require 'haml'
+require 'resque'
+
+module Bulky
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/bulky/updater.rb

@@ -0,0 +1,36 @@
+module Bulky
+  class Updater
+
+    QUEUE = @queue = :bulky_updates
+
+    def self.perform(model_name, update_id, bulk_update_id)
+      model = model_name.constantize.find(update_id)
+      new(model, bulk_update_id).update!
+    end
+
+    def initialize(model, bulk_update_id)
+      @bulk_update = Bulky::BulkUpdate.find(bulk_update_id)
+      @model       = model
+      @updates     = @bulk_update.updates
+    end
+
+    def update!
+      @model.tap do
+        @log = @bulk_update.updated_records.build { |r| r.updatable = @model }
+
+        begin
+          @model.attributes = @updates
+          @log.updatable_changes = @model.changes
+          @model.save!
+        rescue => e
+          @log.error_message   = e.message
+          @log.error_backtrace = e.backtrace.join("\n")
+          raise e
+        ensure
+          @log.save!
+        end
+      end
+    end
+
+  end
+end

data/lib/bulky/version.rb

@@ -0,0 +1,3 @@
+module Bulky
+  VERSION = "0.8.0"
+end

data/lib/tasks/bulky_tasks.rake

@@ -0,0 +1,11 @@
+load "tasks/resque.rake"
+
+namespace :bulky do
+  task :setup do
+    ENV['QUEUE'] = Bulky::Updater::QUEUE.to_s
+    ENV['BACKGROUND'] = true.to_s
+  end
+
+  desc "start a bulky queue worker (in the background)"
+  task :work => [:environment, :setup, :"resque:work"]
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: bulky
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Hunter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.11
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: Bulky allows you bulk update your ActiveRecord models.  It will enqueue
+  the bulk update and run it through the model's lifecycle to ensure validation are
+  performed. Bulky also provides logging of bulk update success or failure.
+email:
+- adamhunter@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/bulky/updates_controller.rb
+- app/helpers/bulky/form_helper.rb
+- app/models/bulky/bulk_update.rb
+- app/models/bulky/updated_record.rb
+- app/views/bulky/updates/edit.html.haml
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20120911145530_create_bulky_tables.rb
+- lib/bulky/engine.rb
+- lib/bulky/updater.rb
+- lib/bulky/version.rb
+- lib/bulky.rb
+- lib/tasks/bulky_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/adamhuner/bulky
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3963931930750602093
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3963931930750602093
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Bulk update your ActiveRecord models.
+test_files: []