rails_admin_aasm 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d24976463c0ceaed6ca795a070b618a610f53f26
+  data.tar.gz: da372859af26075a7ba8f358fec4861c5f70431f
+SHA512:
+  metadata.gz: 31baee41d0feeba6574e7f88ac25991a7896bcefc3fd9b938daaf6b46f0b060246c57ec4d04903bafa1aba829ab1da7327cda9f2896d55981293474f6206b91d
+  data.tar.gz: 426cf57cffe81523dbedac8139ca2ba63cc3b0cf45e163ef10aad530168b7780c1d4250f032ff440a99431e1104fdb9c41ffa98bcd8635689fae4550b23885be

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 glebtv
+
+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,83 @@
+# Rails Admin State Machine
+### Properly manage AASM states from rails_admin
+
+Allows easily sending state_machine events to a model from Rails Admin, including support for
+ActiveRecord \ Mongoid and custom state field name and multiple state machines per model.
+
+Based on https://github.com/rs-pro/rails_admin_state.
+Since state_machine currently is not maintained, I turn to AASM https://github.com/aasm/aasm.
+
+## Installing
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_admin_aasm'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_admin_aasm
+
+## Usage
+
+Add the state action:
+
+    RailsAdmin.config do |config|
+      config.actions do
+        ......
+        state
+      end
+    end
+
+Mark the field you need display as state:
+
+    rails_admin do
+      list do
+        field :state, :state
+        ...
+      end
+      edit do
+        field :state, :state
+        ...
+      end
+      ...
+    end
+
+### States and event button/label custom classes:
+
+    rails_admin do
+      list do
+        field :state, :state
+        ...
+      end
+      ...
+      state({
+        events: {dead: 'btn-danger', drain: 'btn-warning', alive: 'btn-success'},
+        states: {dead: 'label-important', drain: 'label-warning', alive: 'label-success'}
+        disable: [:dead] # disable some events so they are not shown.
+      })
+
+    end
+
+Some classes are preset by default (published, deleted, etc)
+  
+### CanCan integration
+
+    cannot :manage, Recipes::Recipe
+    can :read, Recipes::Recipe
+    can :state, Recipes::Recipe # required to do any transitions
+    can :all_events, Recipes::Recipe
+
+### i18n (state and event names):
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/app/views/rails_admin/main/_form_state.html.haml

@@ -0,0 +1,14 @@
+.state-widget
+  = form.hidden_field field.method_name.to_s + '_event'
+  = field.form_value
+  :javascript
+    $(function() {
+      $('.state-btn').off('click').click(function(e){
+        e.preventDefault();
+        var $t = $(this), d = $t.data();
+        var $i = $t.parents('.state-widget').find('input')
+        $i.val(d.event);
+        $t.siblings().removeClass('active')
+        $t.addClass('active')
+      })
+    })

data/config/locales/en.rails_admin_aasm.yml

@@ -0,0 +1,10 @@
+en:
+  admin:
+    actions:
+      toggle:
+        title: "Toggle"
+    state_machine:
+      event_fired: '%{attr} event %{event} fired'
+      error: "Error: %{err}"
+      no_id: No ID provided
+      no_event: Don't change

data/config/locales/ru.rails_admin_aasm.yml

@@ -0,0 +1,11 @@
+ru:
+  admin:
+    actions:
+      toggle:
+        title: "Переключить"
+    state_machine:
+      event_fired: '%{attr} выполнено событие %{event}'
+      error: "Ошибка: %{err}"
+      no_id: "Не указан ID"
+      no_event: "Не менять"
+    

data/lib/rails_admin_aasm/action.rb

@@ -0,0 +1,55 @@
+module RailsAdmin
+  module Config
+    module Actions
+      class State < Base
+        RailsAdmin::Config::Actions.register(self)
+
+        # Is the action acting on the root level (Example: /admin/contact)
+        register_instance_option :root? do
+          false
+        end
+
+        register_instance_option :collection? do
+          false
+        end
+
+        # Is the action on an object scope (Example: /admin/team/1/edit)
+        register_instance_option :member? do
+          true
+        end
+
+        register_instance_option :controller do
+          Proc.new do |klass|
+            unless @authorization_adapter.nil? || @authorization_adapter.authorized?(:all_events, @abstract_model, @object)
+              @authorization_adapter.try(:authorize, params[:event].to_sym, @abstract_model, @object)
+            end
+
+            @state_machine_options = ::RailsAdminAasm::Configuration.new @abstract_model
+            if params['id'].present?
+              begin
+                raise 'event disabled' if @state_machine_options.disabled?(params[:event].to_sym)
+                # if @object.send("fire_#{params[:attr]}_event".to_sym, params[:event].to_sym)
+                if @object.send("may_#{params[:event]}?".to_sym)
+                  @object.send("#{params[:event]}!")
+                  flash[:success] = I18n.t('admin.state_machine.event_fired', attr: params[:method], event: params[:event])
+                else
+                  flash[:error] = obj.errors.full_messages.join(', ')
+                end
+              rescue Exception => e
+                Rails.logger.error e
+                flash[:error] = I18n.t('admin.state_machine.error', err: e.to_s)
+              end
+            else
+              flash[:error] = I18n.t('admin.state_machine.no_id')
+            end
+            redirect_to :back
+          end
+        end
+
+        register_instance_option :http_methods do
+          [:post]
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_aasm/configuration.rb

@@ -0,0 +1,65 @@
+module RailsAdminAasm
+  class Configuration
+    def initialize(abstract_model)
+      @abstract_model = abstract_model
+    end
+
+    def options
+      @options ||= {
+          states: {
+            published: 'label-success',
+            sent: 'label-success',
+            done: 'label-success',
+            cancelled: 'label-important',
+            deleted: 'label-important',
+            trashed: 'label-important',
+            draft: 'label-important',
+          },
+          events: {
+            publish: 'btn-success',
+            confirm: 'btn-success',
+            send: 'btn-success',
+            done: 'btn-success',
+            cancel: 'btn-danger',
+            delete: 'btn-danger',
+            trash: 'btn-danger',
+          },
+          disable: []
+      }.merge(config)
+      @options
+    end
+
+    def state(name)
+      return '' if name.nil?
+      options[:states][name.to_sym] || ''
+    end
+
+    def event(name)
+      return '' if name.nil?
+      options[:events][name.to_sym] || ''
+    end
+
+    def disabled?(name)
+      return '' if name.nil?
+      options[:disable].include? name.to_sym
+    end
+
+    def authorize?
+      options[:authorize]
+    end
+
+    protected
+    def config
+      begin
+        opt = ::RailsAdmin::Config.model(@abstract_model.model).state
+        if opt.nil?
+          {}
+        else
+          opt
+        end
+      rescue
+        {}
+      end
+    end
+  end
+end

data/lib/rails_admin_aasm/engine.rb

@@ -0,0 +1,4 @@
+module RailsAdminAasm
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/rails_admin_aasm/field.rb

@@ -0,0 +1,100 @@
+require 'builder'
+
+module RailsAdmin
+  module Config
+    module Fields
+      module Types
+        class State < RailsAdmin::Config::Fields::Base
+          # Register field type for the type loader
+          RailsAdmin::Config::Fields::Types::register(self)
+          include RailsAdmin::Engine.routes.url_helpers
+
+          register_instance_option :pretty_value do
+            @state_machine_options = ::RailsAdminAasm::Configuration.new @abstract_model
+            v = bindings[:view]
+
+            state = bindings[:object].send(name)
+            state_class = @state_machine_options.state(state)
+            ret = [
+              '<div class="label ' + state_class + '">' + bindings[:object].aasm.human_state + '</div>',
+              '<div style="height: 10px;"></div>'
+            ]
+
+            bindings[:object].aasm.events.each do |event|
+              next unless v.authorized?(:state, @abstract_model, bindings[:object]) && (v.authorized?(:all_events, @abstract_model, bindings[:object]) || v.authorized?(event.name, @abstract_model, bindings[:object]))
+              event_class = @state_machine_options.event(event.name)
+              ret << bindings[:view].link_to(
+                event.name.to_s.capitalize,
+                state_path(model_name: @abstract_model, id: bindings[:object].id, event: event.name, attr: name),
+                method: :post, 
+                class: "btn btn-mini #{event_class}",
+                style: 'margin-bottom: 5px;'
+              )
+            end
+            ('<div style="white-space: normal;">' + ret.join(' ') + '</div>').html_safe
+          end
+
+          register_instance_option :formatted_value do
+            form_value
+          end
+
+          register_instance_option :form_value do
+            @state_machine_options = ::RailsAdminAasm::Configuration.new @abstract_model
+            c = bindings[:controller]
+            v = bindings[:view]
+
+            state = bindings[:object].send(name)
+            state_class = @state_machine_options.state(state)
+            ret = [
+              '<div class="label ' + state_class + '">' + bindings[:object].aasm.human_state + '</div>',
+              '<div style="height: 10px;"></div>'
+            ]
+
+            empty = true
+            bindings[:object].aasm.events.each do |event|
+              next unless v.authorized?(:state, @abstract_model, bindings[:object]) && (v.authorized?(:all_events, @abstract_model, bindings[:object]) || v.authorized?(event.name, @abstract_model, bindings[:object]))
+              empty = false
+              event_class = @state_machine_options.event(event.name)
+              ret << bindings[:view].link_to(
+                event.name.to_s.capitalize,
+                '#',
+                'data-attr' => name,
+                'data-event' => event.name,
+                class: "state-btn btn btn-mini #{event_class}",
+                style: 'margin-bottom: 5px;'
+              )
+            end
+            unless empty
+              ret << bindings[:view].link_to(
+                I18n.t('admin.state_machine.no_event'),
+                '#',
+                'data-attr' => name,
+                'data-event' => '',
+                class: "state-btn btn btn-mini active",
+                style: 'margin-bottom: 5px;'
+              )
+            end
+            ('<div style="white-space: normal;">' + ret.join(' ') + '</div>').html_safe
+          end
+          
+          register_instance_option :export_value do
+            state = bindings[:object].send(name)
+            bindings[:object].aasm.human_state
+          end
+
+          register_instance_option :partial do
+            :form_state
+          end
+
+          register_instance_option :allowed_methods do
+            [method_name, (method_name.to_s + '_event').to_sym]
+          end
+
+          register_instance_option :multiple? do
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_aasm/model.rb

@@ -0,0 +1,9 @@
+module RailsAdmin
+  module Config
+    class Model
+      register_instance_option :state do
+        nil
+      end
+    end
+  end
+end

data/lib/rails_admin_aasm/version.rb

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

data/lib/rails_admin_aasm.rb

@@ -0,0 +1,10 @@
+require "rails_admin_aasm/version"
+
+require 'rails_admin/config/actions'
+require 'rails_admin/config/model'
+
+require 'rails_admin_aasm/configuration'
+require 'rails_admin_aasm/action'
+require 'rails_admin_aasm/model'
+require 'rails_admin_aasm/field'
+require 'rails_admin_aasm/engine'

data/rails_admin_aasm.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_admin_aasm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_admin_aasm"
+  spec.version       = RailsAdminAasm::VERSION
+  spec.authors       = ["Chuanpin Zhu"]
+  spec.email         = ["zcppku@gmail.com"]
+  spec.description   = %q{Manage model's state with AASM and rails_admin}
+  spec.summary       = %q{Integrate aasm with rails_admin, add a new type into rails_admin, which is state}
+  spec.homepage      = "https://github.com/zcpdog/rails_admin_aasm"
+  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_dependency "rails_admin", "~> 0"
+  spec.add_dependency "aasm", "~> 0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: rails_admin_aasm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chuanpin Zhu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails_admin
+  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: aasm
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Manage model's state with AASM and rails_admin
+email:
+- zcppku@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/rails_admin/main/_form_state.html.haml
+- config/locales/en.rails_admin_aasm.yml
+- config/locales/ru.rails_admin_aasm.yml
+- lib/rails_admin_aasm.rb
+- lib/rails_admin_aasm/action.rb
+- lib/rails_admin_aasm/configuration.rb
+- lib/rails_admin_aasm/engine.rb
+- lib/rails_admin_aasm/field.rb
+- lib/rails_admin_aasm/model.rb
+- lib/rails_admin_aasm/version.rb
+- rails_admin_aasm.gemspec
+homepage: https://github.com/zcpdog/rails_admin_aasm
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Integrate aasm with rails_admin, add a new type into rails_admin, which is
+  state
+test_files: []