rao-service_controller 0.0.2.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df9ac2c6396e345aaf96de272a1e40b131f550a0
+  data.tar.gz: d655544316fef373993f9e325ca34ed7f980b104
+SHA512:
+  metadata.gz: 4cda9a07ef1835aa0bc39de96fc6daf5f9ca1ff81bee61a62b2596f15ed38352965a9004d66700b02641ef71b62d231699a17dc34d08c4ed8971fd4692dbf565
+  data.tar.gz: e06952c6c03f732428ca8e238069f2c5786f23fab6d2a3d911e354cadc75a82b7d16d46249752b2a513833a2bbe577872aa0ee0531f6d4e4dbbc26c2c9dda838

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Roberto Vasquez Angel
+
+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,34 @@
+# Rao::ServiceController
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rao-service_controller'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rao-service_controller
+```
+
+Generate the initializer:
+
+```bash
+$ rails g rao:service_controller:install
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,25 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rails Add-Ons Service Controller'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'

data/app/assets/stylesheets/rao/service_controller/application/table_monospaced.css

@@ -0,0 +1,4 @@
+.table-monospaced * {
+  font-family: monospace;
+  white-space: pre;
+}

data/app/assets/stylesheets/rao/service_controller/application.css

@@ -0,0 +1,3 @@
+/*
+ *= require_tree ./application
+ */

data/app/assets/stylesheets/rao-service_controller.css

@@ -0,0 +1,3 @@
+/*
+ *= require rao/service_controller/application
+ */

data/app/concerns/rao/controller/autosubmit_concern.rb

@@ -0,0 +1,50 @@
+module Raos
+  module Controller
+    # Handles automatic form submits.
+    #
+    # Prerequisites:
+    #
+    # Include the javascript:
+    #
+    #     # app/assets/javascripts/application.js
+    #     //= require rails/add_ons/application/autosubmit
+    #
+    # Example:
+    #
+    #     # app/controllers/posts_controller.rb
+    #     class PostsController < ApplicationController
+    #       include AutosubmitConcern
+    #
+    #       # ...
+    #
+    #       private
+    #
+    #       def autosubmit?
+    #         true
+    #       end
+    #     end
+    #
+    #     # app/views/posts/new.html.haml
+    #     = form_for(...) do |f|
+    #       = autosubmit
+    #
+    module AutosubmitConcern
+      extend ActiveSupport::Concern
+
+      included do
+        helper Rao::AutosubmitHelper
+        helper_method :autosubmit?, :autosubmit_now?
+      end
+
+      private
+
+      def autosubmit?
+        false
+      end
+
+      def autosubmit_now?
+        autosubmit? && action_name == 'new'
+      end
+    end
+  end
+end

data/app/concerns/rao/service_controller/location_history_concern.rb

@@ -0,0 +1,33 @@
+module Rao
+  module ServiceController::LocationHistoryConcern
+    extend ActiveSupport::Concern
+
+    included do
+      if respond_to?(:before_action)
+        before_action :store_location
+      else
+        before_filter :store_location
+      end
+    end
+
+    private
+
+    def store_location
+      truncate_location_history(9)
+      location_history[Time.zone.now] = request.referer
+    end
+
+    def location_history
+      session[:location_history] ||= {}
+    end
+
+    def last_location
+      location_history.sort.last.try(:last)
+    end
+
+    def truncate_location_history(count = 0)
+      return if location_history.size <= count
+      session[:location_history] = session[:location_history].sort.last(count).to_h
+    end
+  end
+end

data/app/concerns/rao/service_controller/rest_actions_concern.rb

@@ -0,0 +1,102 @@
+module Rao
+  module ServiceController::RestActionsConcern
+    extend ActiveSupport::Concern
+
+    included do
+      unless respond_to?(:respond_to)
+        raise "undefined method `respond_to' for #{self.name}: If you are running Rails > 4 you may need to add the responders gem to your Gemfile."
+      end
+
+      respond_to :html
+      responders :flash
+
+      if respond_to?(:before_action)
+        before_action :initialize_service, only: [:new]
+        before_action :initialize_service_for_create, only: [:create]
+      else
+        before_filter :initialize_service, only: [:new]
+        before_filter :initialize_service_for_create, only: [:create]
+      end
+    end
+
+    def new; end
+
+    def create
+      perform
+    end
+
+    private
+
+    def perform
+      @result = execute_service
+      if @result.success?
+
+        if respond_to?(:after_success_location, true) && after_success_location.present?
+          flash.notice = success_message if success_message.present?
+          redirect_to(after_success_location)
+        else
+          flash.now[:notice] = success_message if success_message.present?
+          render :create
+        end
+      else
+        render :new
+      end
+    end
+
+
+    def success_message
+      t('flash.actions.perform.notice', resource_name: @service.class.model_name.human)
+    end
+
+    def execute_service
+      @service.send(execute_method)
+    end
+
+    def execute_method
+      :perform
+    end
+
+    def hashified_params
+      if permitted_params.respond_to?(:to_h)
+        permitted_params.to_h
+      else
+        permitted_params
+      end
+    end
+
+    def initialize_service
+      @service = service_class.new({}, service_options)
+    end
+
+    # Override this method in your child class to manipulate your service before
+    # it performs.
+    #
+    # Example:
+    #     # app/controller/import_services_controller.rb
+    #     class ImportServices < ApplicationServicesController
+    #       #...
+    #       private
+    #
+    #       def initialize_service_for_create
+    #         super
+    #         @service.current_user_id = session['current_user_id']
+    #       end
+    #     end
+    #
+    def initialize_service_for_create
+      @service = service_class.new(hashified_params, service_options)
+    end
+
+    def service_options
+      default_options
+    end
+
+    def default_options
+      { autosave: true }
+    end
+
+    def permitted_params
+      raise "You have to implement permitted_params in #{self.class.name}."
+    end
+  end
+end

data/app/concerns/rao/service_controller/rest_service_urls_concern.rb

@@ -0,0 +1,22 @@
+module Rao
+  module ServiceController::RestServiceUrlsConcern
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :new_service_path,
+                    :create_service_path
+    end
+
+    def new_service_path
+      resource_router.send(:url_for, { action: :new, only_path: true })
+    end
+
+    def create_service_path
+      resource_router.send(:url_for, { action: :create, only_path: true })
+    end
+
+    def resource_router
+      self
+    end
+  end
+end

data/app/concerns/rao/service_controller/service_concern.rb

@@ -0,0 +1,16 @@
+module Rao
+  module ServiceController::ServiceConcern
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :service_class
+    end
+
+    def service_class
+      unless self.class.respond_to?(:service_class)
+        raise "undefined method `service_class' for #{self.class.name}: Add a service_class method to your controller. Example: def self.service_class; MyAmazingService; end"
+      end
+      self.class.service_class
+    end
+  end
+end

data/app/concerns/rao/service_controller/service_inflections_concern.rb

@@ -0,0 +1,17 @@
+module Rao
+  module ServiceController::ServiceInflectionsConcern
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :inflections
+    end
+
+    private
+
+    def inflections
+      {
+        service_name: service_class.model_name.human(count: 1)
+      }
+    end
+  end
+end

data/app/controllers/rao/service_controller/base.rb

@@ -0,0 +1,13 @@
+module Rao
+  module ServiceController
+    class Base < Configuration.service_controller_base_class_name.constantize
+      include ServiceConcern
+      include RestActionsConcern
+      include RestServiceUrlsConcern
+      include ServiceInflectionsConcern
+      include LocationHistoryConcern
+
+      helper Twitter::Bootstrap::Components::Rails::V4::ComponentsHelper
+    end
+  end
+end

data/app/views/rao/service_controller/base/_form_buttons.haml

@@ -0,0 +1,4 @@
+/=# form.button :submit, class: 'btn btn-success' do
+= button_tag class: 'btn btn-success', data: { disable_with: t('.submitted') } do
+  = fa_icon :check if respond_to?(:fa_icon)
+  = t('.submit', service_name: form.object.model_name.human)

data/app/views/rao/service_controller/base/_form_errors.haml

@@ -0,0 +1,7 @@
+- if service.errors.any?
+  = bootstrap_alert(context: :danger, class: 'error-explanation') do
+    - message_default = t('errors.template.header', count: service.errors.count, model: service.class.model_name.human)
+    .error-heading= t('errors.template.services.header', count: service.errors.count, model: service.class.model_name.human, default: message_default)
+    %ul
+      - service.errors.full_messages.each do |msg|
+        %li= msg

data/app/views/rao/service_controller/base/create.html.haml

@@ -0,0 +1,14 @@
+= render 'create_before_service_output', result: @result
+
+%table.table.table-sm.table-striped.table-monospaced
+  %tbody
+    - @result.messages.each_with_index do |message, index|
+      %tr
+        %td= index + 1
+        %td= message
+
+= render 'create_after_service_output', result: @result
+
+= bootstrap_button(to: new_service_path, context: :success) do
+  = fa_icon :back if respond_to?(:fa_icon)
+  = t('.back')

data/app/views/rao/service_controller/base/new.html.haml

@@ -0,0 +1,6 @@
+%h1= t('.title', inflections)
+
+= bootstrap_form_for(@service, url: create_service_path) do |f|
+  = render 'form_errors',  service: f.object
+  = render 'form',         form: f
+  = render 'form_buttons', form: f

data/config/initializers/assets.rb

@@ -0,0 +1,3 @@
+Rails.application.config.assets.precompile += %w(
+  rao-service_controller.css
+)

data/config/locales/de.yml

@@ -0,0 +1,23 @@
+de:
+  flash:
+    actions:
+      create:
+        notice: "%{resource_name} wurde erstellt."
+      update:
+        notice: "%{resource_name} wurde aktualisiert."
+      destroy:
+        notice: "%{resource_name} wurde gelöscht."
+        alert: "%{resource_name} konnte nicht gelöscht werden."
+      perform:
+        notice: "%{resource_name} wurde ausgeführt."
+        alert: "%{resource_name} konnte nicht ausgeführt werden. Es traten folgende Fehler auf: %{errors}"
+  rao:
+    service_controller:
+      base:
+        create:
+          back: "Zurück"
+        form_buttons:
+          submit: "%{service_name} ausführen"
+          submitted: "Wird ausgeführt..."
+        new:
+          title: "%{service_name} ausführen"

data/config/locales/en.yml

@@ -0,0 +1,23 @@
+en:
+  flash:
+    actions:
+      create:
+        notice: "%{resource_name} was successfully created."
+      update:
+        notice: "%{resource_name} was successfully updated."
+      destroy:
+        notice: "%{resource_name} was successfully destroyed."
+        alert: "%{resource_name} could not be destroyed."
+      perform:
+        notice: "%{resource_name} was executed."
+        alert: "%{resource_name} could not be executed. Errors: %{errors}"
+  rao:
+    service_controller:
+      base:
+        create:
+          back: "Back"
+        form_buttons:
+          submit: "Run %{service_name}"
+          submitted: "Running..."
+        new:
+          title: "Run %{service_name}"

data/lib/generators/rao/service_controller/install_generator.rb

@@ -0,0 +1,15 @@
+module Rao
+  module ServiceController
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        desc 'Generates the initializer'
+
+        source_root File.expand_path('../templates', __FILE__)
+
+        def generate_initializer
+          template 'initializer.rb', 'config/initializers/rao-service_controller.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/rao/service_controller/templates/initializer.rb

@@ -0,0 +1,7 @@
+Rao::ServiceController.configure do |config|
+  # Set the base controller for service controllers.
+  #
+  # default: config.service_controller_base_class_name = '::ApplicationController'
+  #
+  config.service_controller_base_class_name = '::ApplicationController'
+end

data/lib/rao/service_controller/configuration.rb

@@ -0,0 +1,11 @@
+module Rao
+  module ServiceController
+    module Configuration
+      def configure
+        yield self
+      end
+
+      mattr_accessor(:service_controller_base_class_name) { '::ApplicationController' }
+    end
+  end
+end

data/lib/rao/service_controller/engine.rb

@@ -0,0 +1,7 @@
+module Rao
+  module ServiceController
+    class Engine < ::Rails::Engine
+      isolate_namespace Rao::ServiceController
+    end
+  end
+end

data/lib/rao/service_controller/version.rb

@@ -0,0 +1,7 @@
+require 'rao/version'
+
+module Rao
+  module ServiceController
+    VERSION = ::Rao::VERSION
+  end
+end

data/lib/rao/service_controller.rb

@@ -0,0 +1,9 @@
+require "rao/service_controller/configuration"
+require "rao/service_controller/version"
+require "rao/service_controller/engine"
+
+module Rao
+  module ServiceController
+    extend Configuration
+  end
+end

data/lib/rao-service_controller.rb

@@ -0,0 +1,4 @@
+require 'font-awesome-rails'
+require 'simple_form'
+require 'twitter-bootstrap-components-rails'
+require "rao/service_controller"

data/lib/tasks/rao-service_controller_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rao_service_controller do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: rao-service_controller
+version: !ruby/object:Gem::Version
+  version: 0.0.2.pre
+platform: ruby
+authors:
+- Roberto Vasquez Angel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rao
+  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: simple_form
+  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: twitter-bootstrap-components-rails
+  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: font-awesome-rails
+  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: rspec
+  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: guard-rspec
+  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: guard-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'
+description: 
+email:
+- roberto@vasquez-angel.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/rao-service_controller.css
+- app/assets/stylesheets/rao/service_controller/application.css
+- app/assets/stylesheets/rao/service_controller/application/table_monospaced.css
+- app/concerns/rao/controller/autosubmit_concern.rb
+- app/concerns/rao/service_controller/location_history_concern.rb
+- app/concerns/rao/service_controller/rest_actions_concern.rb
+- app/concerns/rao/service_controller/rest_service_urls_concern.rb
+- app/concerns/rao/service_controller/service_concern.rb
+- app/concerns/rao/service_controller/service_inflections_concern.rb
+- app/controllers/rao/service_controller/base.rb
+- app/views/rao/service_controller/base/_create_after_service_output.haml
+- app/views/rao/service_controller/base/_create_before_service_output.haml
+- app/views/rao/service_controller/base/_form_buttons.haml
+- app/views/rao/service_controller/base/_form_errors.haml
+- app/views/rao/service_controller/base/create.html.haml
+- app/views/rao/service_controller/base/new.html.haml
+- config/initializers/assets.rb
+- config/locales/de.yml
+- config/locales/en.yml
+- lib/generators/rao/service_controller/install_generator.rb
+- lib/generators/rao/service_controller/templates/initializer.rb
+- lib/rao-service_controller.rb
+- lib/rao/service_controller.rb
+- lib/rao/service_controller/configuration.rb
+- lib/rao/service_controller/engine.rb
+- lib/rao/service_controller/version.rb
+- lib/tasks/rao-service_controller_tasks.rake
+homepage: https://github.com/rao
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Services Controller for Ruby on Rails.
+test_files: []