active_admin-workflow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 910edfe17e1654c02ff59d9e79407b7ded9c2acf27f668997c7c883727e49ef0
+  data.tar.gz: 003a48e42ffa3e3cf6e14a0ac64d8ae27493b7662bf60a3d9f8c0d6b639c6f48
+SHA512:
+  metadata.gz: ecf463d9019f9e6a3cb2bffb3516fa0f0c7f633174cca9a1d783c0133bc042305553b25a7a234ac9b38bbb6e71c6620d0e14b2ff5bf38e1198914acef3a07e19
+  data.tar.gz: ebc625981af2a6b898dd9022a9a35d2efd48df4c48f1b6986a99a5eae23078a0f2bae19b4557a892b6068b4a91d9fc19375198468e8fca88ec1e15fb64c039a6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 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,145 @@
+# ActiveAdmin-Workflow
+
+[![Version      ](https://badge.fury.io/rb/active_admin-workflow.svg)](https://badge.fury.io/rb/active_admin-workflow)
+[![Build Status](https://travis-ci.org/kwent/active_admin-workflow.svg?branch=master)](https://travis-ci.org/kwent/active_admin-workflow)
+
+This gem provides an easy integration between the awesome [workflow](https://github.com/geekq/workflow) and [active_admin](https://github.com/gregbell/active_admin) gems.
+
+## Features
+
+This gem provides you with a DSL extension to ActiveAdmin that allows you to easily define action item buttons for your resource to transition through your workflow.
+
+* Integration with ActiveAdmin authorization adapater layer - the button won't show if the user isn't authorized
+* Provide custom permission to authorize against
+* Provide confirmation message to prompt user before performing
+* Button only shown if workflow can transition
+* Localizable button titles and flash messages
+* Pass a block to customize the behavior
+
+## Installation
+
+This gem requires both `active_admin` and `workflow`.  Add the gem to your Gemfile to get started and bundle.
+
+```ruby
+gem 'active_admin-workflow'
+```
+
+## Usage
+
+You will need to define a workflow in a model, and have that model registered as a resource with ActiveAdmin.
+
+**A basic model**
+
+```
+# app/models/post.rb
+class Post < ActiveRecord::Base
+  include WorkflowActiverecord
+
+  validates :title, presence: true, uniqueness: true
+  validates :body, presence: true
+
+  DRAFT = 'draft'
+  REVIEWED = 'reviewed'
+  PUBLISHED = 'published'
+
+  workflow do
+    state DRAFT do
+      event :peer_review, transitions_to: REVIEWED
+    end
+    state REVIEWED do
+      event :publish, transitions_to: PUBLISHED
+    end
+    state PUBLISHED do
+      event :archive, transitions_to: ARCHIVED
+    end
+  end
+end
+```
+
+**Corresponding ActiveAdmin resource**
+
+```
+ActiveAdmin.register Post do
+
+  state_action :peer_review
+  state_action :publish
+
+  form do |f|
+    f.inputs "Post Details" do
+      f.input :title
+      f.input :body
+    end
+    f.actions
+  end
+
+end
+```
+
+In the above example, the `state_action` method is defined by this gem and provides you with the following functionality:
+
+1. The `:peer_review` is assumed to be an event in your workflow definition on the Post model.
+2. Calling `state_action` will add an action item button to your ActiveAdmin resource on the `#show` page, if the user is authorized to perform this action via the ActiveAdmin authorization adapter, and if the resource itself returns true to `#can_peer_review?`, which is provided by default with this event in workflow.
+3. Clicking the button will call `#peer_review!` on the resource, and redirect you back to `smart_resource_url`.
+4. Fully localizable, provide translations for `"posts.peer_review.label"`for the button title and `"posts.peer_review.flash.success` for the flash message when completed.
+5. You can pass a block to customize this behavior.
+
+### Custom Block
+
+```
+ActiveAdmin.register Post do
+
+  state_action :peer_review
+
+  # Block to be called when submitted
+  state_action :publish do
+    PostPublicationService.publish!(resource)
+    flash[:notice] = "Post published"
+    redirect_to collection_path
+  end
+
+end
+```
+
+### Custom Permission
+
+```
+ActiveAdmin.register Post do
+
+  # by default, permission would be :peer_review
+  state_action :peer_review, permission: :read
+end
+```
+
+### Confirmation
+
+```
+ActiveAdmin.register Post do
+
+  # Lookup 'posts.peer_review.prompt'
+  state_action :peer_review, confirm: :true
+
+  # Pass proc
+  state_action :peer_review, confirm: ->{ I18n.t("posts.peer_review.confirm") }
+end
+```
+
+### Using without workflow model
+
+If you really want to use without a workflow on your model, you essentially just need to provide the following methods, contining with our `:peer_review` example:
+
+```
+class Post < ActiveRecord::Base    
+  def can_peer_review?
+    author.present? && !published?
+  end
+
+  def peer_review!
+    self.published_at = Time.now
+    save!
+  end
+end
+```
+
+## Credits
+
+Based on the amazing work of @macfanatic: https://github.com/macfanatic/active_admin-state_machine

data/Rakefile

@@ -0,0 +1,17 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/lib/active_admin/workflow.rb

@@ -0,0 +1,6 @@
+require 'active_admin'
+require 'workflow'
+
+require 'active_admin/workflow/dsl'
+
+ActiveAdmin::DSL.send :include, ActiveAdmin::Workflow::DSL

data/lib/active_admin/workflow/dsl.rb

@@ -0,0 +1,65 @@
+module ActiveAdmin
+  module Workflow
+    module DSL
+
+      #
+      # Easily tie into a workflow action
+      #
+      # @param [Symbol] state machine event, ie: :publish
+      # @param [Hash] options
+      #   - permission [Symbol] permission to check authorization against
+      #   - http_verb [Symbol] :put, :post, :get, etc
+      #
+      # Will call "resource.publish!", if "resource.can_publish?" returns true
+      #
+
+      def state_action(action, options={}, &controller_action)
+        singular = config.resource_name.singular
+        plural = config.resource_name.plural
+
+        options[:permission] ||= controller.new.send(:action_to_permission, action)
+        confirmation = options.fetch(:confirm, false)
+        if confirmation == true
+          default = "Are you sure you want to #{action.to_s.humanize.downcase}?"
+          confirmation = ->{ I18n.t(:confirm, scope: "#{plural}.#{action}", default: default) }
+        end
+
+        http_verb = options.fetch :http_verb, :put
+
+        action_item_args = if ActiveAdmin::VERSION.start_with?('0.')
+                             [{ only: :show }]
+                           else
+                             ["state_action_#{action}", { only: :show }]
+                           end
+        action_item(*action_item_args) do
+          if resource.send("can_#{action}?") && authorized?(options[:permission], resource)
+            path = resource_path << "/#{action}"
+            label = I18n.t("#{plural}.#{action}.label", default: action.to_s.titleize)
+
+            link_options = {}
+            if confirmation.is_a?(Proc)
+              link_options[:data] ||= {}
+              link_options[:data][:confirm] = instance_exec(&confirmation)
+            end
+
+            link_options[:class] = "btn btn-large"
+            link_options[:method] = http_verb
+
+            link_to label, path, link_options
+          end
+        end
+
+        unless block_given?
+          controller_action = -> do
+            resource.send("#{action}!")
+            flash[:notice] = t("#{plural}.#{action}.flash.success")
+            redirect_to smart_resource_url
+          end
+        end
+
+        member_action action, method: http_verb, &controller_action
+      end
+
+    end
+  end
+end

data/lib/active_admin/workflow/version.rb

@@ -0,0 +1,5 @@
+module ActiveAdmin
+  module Workflow
+    VERSION = "0.1.0"
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.