admin_script 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45a05e2bb2442cfcb8f079507a2e57f34ac4d3d9
+  data.tar.gz: 7053298a2a820ea581ec750924f2676b2e6445c5
+SHA512:
+  metadata.gz: 42975dd1ee0b39c165cf68cb7412b717d7b72a88ce0b142179f6f4fc298662cd6e7be1c56fe99536e1f9578b33bb8c4a97b248c178de1e712668b40cbac2ad3e
+  data.tar.gz: aca914a2f6fcec289192acf67dd8b6497018dcb5ca017af5185fb3b538b106cb2bf812bc3feecafb742241f1f8122b2350c68eaaaa78cd6715d6117627d7dee9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,57 @@
+# AdminScript
+
+A module for creating flexible, simple scripts for project in Rails.
+
+<img width="1147" alt="edit_page_example" src="https://cloud.githubusercontent.com/assets/1688137/21744577/cd1d3bac-d55b-11e6-8a9d-bda96edd4d36.png">
+
+## Why use an AdminScript?
+
+I do not want to design RESTful resource for such scripts that run only a few times a month.   
+A new template is also a complete waste of time.
+
+Therefore, AdminScript provides management page of scripts.  
+Only once to define model to perform a script, it generates template automatically.  
+No configuration of routing, controller, template and as so on needed.
+
+## Getting Started
+
+Add AdminScript to your Gemfile:
+
+```ruby
+gem 'admin_script'
+```
+
+Re-bundle, then run the installer:
+
+```
+$ bundle exec rails generate admin_script:install
+```
+
+AdminScript provides a rails engine that can display listing of your scripts.
+Add the following to your `config/routes.rb`
+
+```
+mount AdminScript::Engine => '/admin_scripts'
+```
+
+### Generators
+
+When you have AdminScript installed
+
+```
+bundle exec rails generate admin_script:model awesome_script
+```
+
+...to create the `AdminScript::AwesomeScript`.
+
+## Development
+
+no doc
+
+## Links
+
+- [Wiki](https://github.com/alpaca-tc/admin_script/wiki)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alpaca-tc/admin_script.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/admin_script.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'admin_script/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'admin_script'
+  spec.version       = AdminScript::VERSION
+  spec.authors       = ['alpaca-tc']
+  spec.email         = ['alpaca-tc@alpaca.tc']
+  spec.licenses    = ['MIT']
+
+  spec.summary       = %q{A module for creating flexible, simple scripts for project in Rails.}
+  spec.homepage      = 'https://github.com/alpaca-tc/admin_script'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails', '>= 4.1.0', '< 6.0.0'
+  spec.add_dependency 'method_source', '>= 0.8.0', '< 0.10.0'
+  spec.add_dependency 'slim-rails', '>= 3.0.0', '< 5.0.0'
+  spec.add_dependency 'bootstrap-sass', '>= 3.0.0', '< 5.0.0'
+  spec.add_dependency 'sass-rails', '>= 3.2', '< 7.0.0'
+  spec.add_dependency 'jquery-rails', '>= 1.0.0', '< 6.0.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3', '>= 1.3'
+  spec.add_development_dependency 'bundler', '~> 1.13', '>= 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0', '>= 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+end

data/app/assets/javascripts/admin_script/application.js

@@ -0,0 +1,19 @@
+//= require admin_script/jquery-2.2.4.min
+//= require jquery_ujs
+//= require bootstrap-sprockets
+//= require admin_script/moment-with-locales
+//= require admin_script/bootstrap-datetimepicker.min
+//= require_self
+
+'use strict';
+
+$(document).on('ready page:load', function() {
+  $('[data-behaviour~=datepicker]').datetimepicker({
+    showClose: true,
+    format: 'YYYY/MM/DD'
+  });
+
+  $('[data-behaviour~=datetimepicker]').datetimepicker({
+    showClose: true
+  });
+});

data/app/assets/stylesheets/admin_script/application.scss

@@ -0,0 +1,3 @@
+@import 'bootstrap-sprockets';
+@import 'bootstrap';
+@import 'admin_script/bootstrap-datetimepicker';

data/app/controllers/admin_script/admin_scripts_controller.rb

@@ -0,0 +1,40 @@
+class ::AdminScript::AdminScriptsController < AdminScript.configuration.parent_controller.constantize
+  before_action :set_admin_script_class, only: [:edit, :update]
+
+  def index
+    @admin_scripts = AdminScript::Base.subclasses.sort_by(&:to_s).map(&:new)
+  end
+
+  def edit
+    @admin_script = @admin_script_class.new(admin_script_params)
+  end
+
+  def update
+    @admin_script = @admin_script_class.new(admin_script_params)
+
+    if @admin_script.perform
+      default_path = admin_script.routes.url_helpers.admin_scripts_path
+      location = @admin_script.location_url.presence || default_path
+      message = @admin_script.success_message.presence || t('admin_script.admin_scripts.update.successfully_performed')
+
+      redirect_to location, notice: message
+    else
+      message = @admin_script.failure_message.presence || t('admin_script.admin_scripts.update.failed_performing')
+      flash.now[:alert] = message
+
+      render :edit, status: :unprocessable_entity
+    end
+  end
+
+  private
+
+  def admin_script_params
+    params.require(:admin_script).permit(@admin_script_class.type_attributes.keys)
+  rescue ActionController::ParameterMissing
+    nil
+  end
+
+  def set_admin_script_class
+    @admin_script_class = AdminScript::Base.find_class(params[:id])
+  end
+end

data/app/controllers/admin_script/application_controller.rb

@@ -0,0 +1,4 @@
+module AdminScript
+  class ApplicationController < AdminScript.configuration.parent_controller.constantize
+  end
+end

data/app/views/admin_script/admin_scripts/_default_form.html.slim

@@ -0,0 +1,26 @@
+- f.object.class.type_attributes.each do |name, type|
+  .form-group
+    - if type == :boolean
+      .checkbox
+        = f.label name, class: 'form-label'
+          = f.check_box name
+          = name
+    - else
+      = f.label name
+      - case type
+      - when :integer, :big_integer
+        = f.number_field name, class: 'form-control'
+      - when :float, :decimal
+        = f.number_field name, step: 0.01, class: 'form-control'
+      - when :string
+        = f.text_field name, class: 'form-control'
+      - when :date
+        = f.text_field name, class: 'form-control', data: { behaviour: 'datepicker' }
+      - when :datetime
+        = f.text_field name, class: 'form-control', data: { behaviour: 'datetimepicker' }
+      - when :binary
+        = f.file_field name, class: 'form-control'
+      - when :text
+        = f.text_field name, class: 'form-control'
+      - when :time
+        = f.time_select name, class: 'form-control'

data/app/views/admin_script/admin_scripts/edit.html.slim

@@ -0,0 +1,22 @@
+- content_for(:title, t('.title', id: @admin_script.to_param))
+h1.page-header = yield(:title)
+
+.panel.panel-default style='position: relative'
+  .panel-body
+    - url = AdminScript::Engine.routes.url_helpers.admin_script_path(@admin_script)
+    = form_for @admin_script, url: url, as: :admin_script, method: 'patch' do |f|
+      .form-group
+        = f.label :description
+        p = simple_format f.object.description
+
+      / Find custom template or default template
+      - template = @admin_script.model_name.element
+      - if lookup_context.exists?(template, lookup_context.prefixes, true)
+        = render template, f: f
+      - else
+        = render 'admin_script/admin_scripts/default_form', f: f
+
+      = f.button t('.perform'), class: 'btn btn-default', data: { confirm: t('.confirm') }
+
+  .panel-footer
+    pre = @admin_script.class.script

data/app/views/admin_script/admin_scripts/index.html.slim

@@ -0,0 +1,15 @@
+- content_for(:title, t('.title'))
+h1.page-header = yield(:title)
+
+table.table.table-hover
+  thead
+    tr
+      th = AdminScript::Base.model_name.human
+      th = AdminScript::Base.human_attribute_name(:description)
+      th
+  tbody
+    - @admin_scripts.each do |instance|
+      tr
+        td = instance.to_param
+        td = simple_format instance.description
+        td = link_to t('.open'), AdminScript::Engine.routes.url_helpers.edit_admin_script_path(instance), class: 'btn btn-default'

data/app/views/layouts/admin_script/application.html.slim

@@ -0,0 +1,20 @@
+doctype html
+html
+  head
+    meta charset='UTF-8'
+    meta name='referrer' content='no-referrer'
+
+    = stylesheet_link_tag 'admin_script/application', media: :all
+    = javascript_include_tag 'admin_script/application'
+    = csrf_meta_tags
+
+    title = [yield(:title).presence].compact.join(' | ')
+
+  body
+    .container
+      - { notice: :success, alert: :danger }.each do |key, type|
+        - if flash[key].present?
+          div class="alert alert-#{type}"
+            p = flash[key]
+
+      = yield

data/config/locales/admin_script/en.yml

@@ -0,0 +1,21 @@
+en:
+  activemodel:
+    models:
+      admin_script/base: AdminScript
+
+    attributes:
+      admin_script/base:
+        description: Description
+
+  admin_script:
+    admin_scripts:
+      index:
+        title: Listing of AdminScripts
+        open: Open
+      edit:
+        title: 'AdminScript - %{id}'
+        perform: Perform
+        confirm: Are you sure?
+      update:
+        successfully_performed: Successfully performed
+        failed_performing: Failed performing

data/config/locales/admin_script/ja.yml

@@ -0,0 +1,21 @@
+ja:
+  activemodel:
+    models:
+      admin_script/base: AdminScript
+
+    attributes:
+      admin_script/base:
+        description: 詳細
+
+  admin_script:
+    admin_scripts:
+      index:
+        title: AdminScript一覧
+        open: 開く
+      edit:
+        title: 'AdminScript - %{id}'
+        perform: 実行
+        confirm: 実行してよろしいですか？
+      update:
+        successfully_performed: 実行しました
+        failed_performing: 実行できませんでした

data/config/routes.rb

@@ -0,0 +1,5 @@
+AdminScript::Engine.routes.draw do
+  resources :admin_scripts, only: [:index, :edit, :update],
+    path: '',
+    controller: AdminScript.configuration.controller_path
+end

data/dummy/.gitignore

@@ -0,0 +1,2 @@
+/log
+/tmp

data/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/dummy/app/models/admin_script/expire_user_session.rb

@@ -0,0 +1,27 @@
+module AdminScript
+  class ExpireUserSession < AdminScript::Base
+    self.description = 'Expire user session'
+
+    # Define type attribute to cast user input.
+    # the following defines `#id` and `#id=` as typecast method.
+    type_attribute :id, :integer
+
+    attr_reader :user
+
+    validates :id, :user, presence: true
+    before_validation :set_user
+
+    def perform
+      return false unless valid?
+      user.expire_session!
+
+      true
+    end
+
+    private
+
+    def set_user
+      @user = User.find_by(id: id) if id
+    end
+  end
+end

data/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/dummy/config/application.rb

@@ -0,0 +1,14 @@
+require_relative 'boot'
+
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'sprockets/railtie'
+
+Bundler.require(*Rails.groups)
+require 'admin_script'
+
+module Dummy
+  class Application < Rails::Application
+  end
+end
+

data/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/dummy/config/environments/development.rb

@@ -0,0 +1,9 @@
+Rails.application.configure do
+  config.cache_classes = false
+  config.eager_load = false
+  config.consider_all_requests_local = true
+  config.action_controller.perform_caching = false
+  config.active_support.deprecation = :log
+  config.assets.debug = true
+  config.assets.quiet = true
+end

data/dummy/config/environments/test.rb

@@ -0,0 +1,15 @@
+Rails.application.configure do
+  config.cache_classes = true
+  config.eager_load = false
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    'Cache-Control' => 'public, max-age=3600'
+  }
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.action_dispatch.show_exceptions = false
+  config.action_controller.allow_forgery_protection = false
+  config.action_mailer.perform_caching = false
+  config.action_mailer.delivery_method = :test
+  config.active_support.deprecation = :stderr
+end

data/dummy/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  root to: redirect('/engine')
+  mount AdminScript::Engine => '/engine'
+end

data/dummy/config/secrets.yml

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rails secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: 3c85f8a36c79047c57b5114b03fdf81000e56d24018054ce13da8bbac0804ab352fea5eb54bb016b3a9dc948851282b1f77fbaf142d87fededbff18ecb7f46c1
+
+test:
+  secret_key_base: 7661dae72742599ad1c835a4575ed5c81e757c99d29878cf9e51cfb19e46092480ed31482ebd46a9e612e56aa82842973633a00c950bdf6744d0152ce563e3b4
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/dummy/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application

data/lib/admin_script/base.rb

@@ -0,0 +1,84 @@
+require 'active_support/core_ext/class/subclasses'
+require 'active_model'
+require 'method_source'
+
+module AdminScript
+  class Base
+    include AdminScript::TypeAttributes
+    include ActiveModel::Model
+    include ActiveModel::Validations::Callbacks
+    extend ActiveModel::Callbacks
+
+    define_model_callbacks :initialize, only: :after
+
+    attr_accessor :location_url
+
+    class << self
+      RESERVED_CLASSE_NAMES = %w(
+        AdminScript::Base
+        AdminScript::Configuration
+        AdminScript::Engine
+        AdminScript::TypeAttributes
+        AdminScript::VERSION
+      ).freeze
+
+      def inherited(subclass)
+        if RESERVED_CLASSE_NAMES.include?(subclass.to_s)
+          raise ArgumentError, "Reserved class name given. #{subclass}"
+        end
+
+        super
+
+        subclass.class_exec do
+          cattr_accessor :description
+          cattr_accessor :type_attributes
+          self.type_attributes = {}
+        end
+      end
+
+      def type_attribute(name, type)
+        name = name.to_sym
+        type = type.to_sym
+
+        define_type_attribute_accessor(name, type)
+        type_attributes.merge!(name => type)
+      end
+
+      def to_param
+        model_name.element
+      end
+
+      def find_class(element)
+        subclasses.find { |klass| klass.to_param == element }
+      end
+
+      def script
+        instance_method(:perform).source
+      end
+    end
+
+    def initialize(*)
+      run_callbacks :initialize do
+        super
+      end
+    end
+
+    def to_param
+      self.class.to_param
+    end
+
+    def perform
+      raise NotImplementedError, 'not implemented yet.'
+    end
+
+    def failure_message; end
+
+    def success_message; end
+
+    private
+
+    def url_helpers
+      Rails.application.routes.url_helpers
+    end
+  end
+end

data/lib/admin_script/bootstrap.rb

@@ -0,0 +1,20 @@
+require 'sass'
+
+module AdminScript
+  class Bootstrap
+    def load!
+      require 'sass'
+      ::Sass.load_paths << stylesheets_path
+    end
+
+    private
+
+    def gem_path
+      File.expand_path('../..', File.dirname(__FILE__))
+    end
+
+    def stylesheets_path
+      File.join(gem_path, 'vendor', 'stylesheets')
+    end
+  end
+end

data/lib/admin_script/configuration.rb

@@ -0,0 +1,32 @@
+require 'delegate'
+
+module AdminScript
+  class Configuration
+    def self.define_configuration(name, default: nil)
+      define_method name do
+        @configurations[name]
+      end
+
+      define_method :"#{name}=" do |value|
+        @configurations[name] = value
+      end
+
+      default_configurations[name] = default
+    end
+
+    def self.default_configurations
+      @default_configurations ||= {}
+    end
+
+    def initialize
+      @configurations = self.class.default_configurations.clone
+    end
+
+    define_configuration(:admin_script_paths, default: [
+      (Rails.root.join('app', 'models', 'admin_script').to_s if defined?(Rails))
+    ])
+    define_configuration(:parent_controller, default: 'ActionController::Base')
+    define_configuration(:default_url_options, default: {})
+    define_configuration(:controller_path, default: 'admin_scripts')
+  end
+end

data/lib/admin_script/engine.rb

@@ -0,0 +1,40 @@
+require 'slim-rails'
+require 'bootstrap-sass'
+require 'jquery-rails'
+
+module AdminScript
+  class Engine < ::Rails::Engine
+    isolate_namespace AdminScript
+
+    AdminScript::Bootstrap.new.load!
+
+    initializer 'admin_script.i18n' do |app|
+      array = Array.wrap(app.config.i18n.available_locales)
+      available_locales = array.blank? ? '*' : "{#{array.join ','}}"
+
+      locale_pattern = File.expand_path("../../../config/locales/admin_script/#{available_locales}.yml", __FILE__)
+      locale_files = Dir[locale_pattern]
+
+      app.config.i18n.load_path += locale_files
+    end
+
+    config.assets.paths += %w(stylesheets javascripts fonts).map do |path|
+      File.expand_path("../../../vendor/#{path}", __FILE__)
+    end
+
+    config.after_initialize do
+      AdminScript::Engine.routes.default_url_options = AdminScript.configuration.default_url_options.presence ||
+        Rails.application.routes.default_url_options
+    end
+
+    config.to_prepare do
+      AdminScript.configuration.admin_script_paths.each do |path|
+        finder = Pathname.new(path).join('**', '*.rb')
+
+        Dir[finder].each do |path|
+          require_dependency(path)
+        end
+      end
+    end
+  end
+end