shikigami 0.1.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 946fda0f686e374b07bc61862dc2de9bfe897ee8
+  data.tar.gz: de9466a0dfc2350587f2ba11cb00a0c0564c8ee3
+SHA512:
+  metadata.gz: 2453eefc4dd805710cc3403b650a6701d764497d1e60fcba164526e0050489fe83cc9c828cfebee4fa634156ce917b0b61781f63b1ef90d97ae484c139508305
+  data.tar.gz: a97e442433f3bf6edbb88498acbe9ffe3fd96652b49b12c03b2f6c6c2ea68e08e0e04f77fcbb2dcc34b12854f0bd2664de3b420f0c8060545377cfaacac0f0b0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tsehau Chao
+
+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,128 @@
+# shikigami / 式神
+[![Gem Version](https://badge.fury.io/rb/shikigami.svg)](https://badge.fury.io/rb/shikigami)
+[![Code Climate](https://codeclimate.com/github/jodeci/shikigami/badges/gpa.svg)](https://codeclimate.com/github/jodeci/shikigami)
+[![Test Coverage](https://codeclimate.com/github/jodeci/shikigami/badges/coverage.svg)](https://codeclimate.com/github/jodeci/shikigami/coverage)
+[![Build Status](https://travis-ci.org/jodeci/shikigami.svg?branch=master)](https://travis-ci.org/jodeci/shikigami)
+
+*shikigami* is meant to make creating basic CRUD Rails apps as brain dead easy as possible.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem "shikigami"
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+*shikigami* utilizes the I18n library and you will need to have these information in your locale file:
+
+```
+zh-TW:
+  success:
+    create: 新建資料成功
+    update: 修改資料成功
+    destroy: 刪除資料成功
+
+  actions:
+    new: 新增
+    edit: 修改
+    show: 檢視
+    destroy: 刪除
+
+  confirm:
+    destroy: 確認要刪除？
+
+  warnings:
+    no_data: 尚無資料
+```
+
+Or, just let *shikigami* generate the locale file for you:
+
+```
+$ rails generate shikigami:install
+``` 
+
+*shikigami* also assumes that you use [Kaminari](https://github.com/amatsuda/kaminari) for pagination and bootstrap for layout.
+
+Tested with Rails 5 and Ruby 2.3.
+
+## Usage
+
+*Original credit goes to [@ryudoawaru](https://github.com/ryudoawaru). I've been using this almost everywhere, with some tweaks of my own, so I figured I'd might as well put together a gem.*
+
+*shikigami* provides an abstract controller to handle CRUD actions in `Shikigami::BaseController`. Simply inherit your controllers from *shikigami*, specify the relevant `current_scope` and `resource_params`, and you're done. *shikigami* will do the remaining boring stuff for you.
+
+```
+# all set!
+class BooksController < Shikigami::BaseController
+  def current_scope
+    Book
+  end
+  
+  def resource_params
+    parms.require(:book).permit(:title, :author)
+  end
+end
+```
+
+Then, in your view, just use `current_collection` or `current_object` to access your data.
+
+```
+# app/views/books/show.html.slim
+h1 = current_object.title
+
+# app/views/books/index.html.slim
+- current_collection.each do |item|
+  = item.title
+```
+
+Obviously, *shikigami* is only meant for the most basic CRUD Rails apps. If you need something more fancy, you shouldn't be using it :p
+
+## View Helpers
+
+### no\_data\_alert
+
+Generates the following HTML:
+
+```
+# no_data_alert
+<div class="alert alert-warning">尚無資料</div>
+```
+
+### bootstrap\_dropdown\_toggle
+
+Generates the following HTML. `bs_dd_toggle` for short. Yeah, I'm lazy.
+
+```
+# bootstrap_dropdown_toggle("something")
+<a class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">something<span class="caret"></span></a>
+```
+
+### bootstrap\_button
+
+Generates a bootstrap button style link. `bs_btn`
+ for short.
+ 
+```
+# bs_btn(:edit, "#")
+<a class="btn btn-xs btn-warning" href="#">修改</a>
+```
+
+By default, *shikigami* generated buttons will be sized as `.btn-xs`. Unless specified otherwise, it will use `.btn-info` for `show` actions, `.btn-warning` for `edit` actions, and `.btn-danger` for `destroy` actions. 
+
+You can also pass in methods and confirmation:
+
+```
+# bs_btn(:destroy, "#", method: :delete, confirm: true)
+<a class="btn btn-xs btn-danger" data-confirm="確認要刪除？" rel="nofollow" data-method="delete" href="#">刪除</a>
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/controllers/shikigami/base_controller.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+module Shikigami
+  class BaseController < ApplicationController
+    helper_method :current_collection, :current_object
+
+    def index
+    end
+
+    def show
+    end
+
+    def new
+      @current_object = collection_scope.new
+    end
+
+    def create
+      @current_object = collection_scope.new(resource_params)
+      return render action: :new unless @current_object.save
+      action_success
+    end
+
+    def destroy
+      current_object.destroy
+      action_success
+    end
+
+    def edit
+    end
+
+    def update
+      if current_object.update(resource_params)
+        action_success
+      else
+        respond_to do |format|
+          format.html { return render action: :edit }
+          format.json
+        end
+      end
+    end
+
+    private
+
+    def action_success
+      respond_to do |format|
+        format.html do
+          flash[:success] ||= t("success.#{action_name}")
+          redirect_to send("url_after_#{action_name}")
+        end
+        format.json
+      end
+    end
+
+    # override in controller if needed
+    def url_after_create
+      url_for(action: :edit, id: current_object.id)
+    end
+
+    def url_after_update
+      url_for(action: :edit, id: current_object.id)
+    end
+
+    def url_after_destroy
+      url_for(action: :index)
+    end
+
+    # You should implement these in your controller
+    def collection_scope; end
+
+    def resource_params; end
+
+    def current_collection
+      @current_collection ||= collection_scope.page(params[:page])
+    end
+
+    def current_object
+      @current_object ||= collection_scope.find(params[:id])
+    end
+  end
+end

data/lib/generators/shikigami/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require "rails/generators/base"
+module Shikigami
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __FILE__)
+    desc "Creates a locale file for your application"
+    class_option :locale, default: Rails.application.config.i18n.default_locale
+
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), "templates")
+    end
+
+    def copy_locale
+      copy_file "locale.yml", "config/locales/shikigami.#{options[:locale]}.yml"
+    end
+  end
+end

data/lib/generators/shikigami/templates/locale.yml

@@ -0,0 +1,16 @@
+#zh-TW:
+#  success:
+#    create: 新建資料成功
+#    update: 修改資料成功
+#    destroy: 刪除資料成功
+
+#  actions:
+#    show: 檢視
+#    edit: 修改
+#    destroy: 刪除
+
+#  confirm:
+#    destroy: 確認要刪除？
+
+#  warnings:
+#    no_data: 尚無資料

data/lib/shikigami.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require "shikigami/version"
+require "shikigami/railtie"
+require "shikigami/engine"
+module Shikigami
+end

data/lib/shikigami/bootstrap_button.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require "i18n"
+require "active_support/core_ext/hash"
+module Shikigami
+  class BootstrapButton
+    def initialize(action, options = {})
+      @action = action.to_s
+      @options = options
+    end
+
+    def options
+      {
+        class: default_class,
+        method: @options[:method],
+        data: confirm_message,
+      }
+    end
+
+    private
+
+    def size
+      @options[:size] || "xs"
+    end
+
+    def style
+      @options[:style] || default_style
+    end
+
+    def confirm_message
+      { confirm: default_message } if @options[:confirm]
+    end
+
+    def default_message
+      I18n.t("confirm.#{@action}", raise: true)
+    rescue
+      "Are you sure?"
+    end
+
+    def default_class
+      "btn btn-#{size} btn-#{style}"
+    end
+
+    def default_style
+      case @action
+      when "show" then "info"
+      when "edit" then "warning"
+      when "destroy" then "danger"
+      else "primary"
+      end
+    end
+  end
+end

data/lib/shikigami/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require "rails/engine"
+require "kaminari"
+module Shikigami
+  class Engine < Rails::Engine
+  end
+end

data/lib/shikigami/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require "rails/railtie"
+require "shikigami/view_helpers"
+module Shikigami
+  class Railtie < Rails::Railtie
+    initializer "shikigami.view_helpers" do
+      ActiveSupport.on_load(:action_view) { include Shikigami::ViewHelpers }
+    end
+  end
+end

data/lib/shikigami/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Shikigami
+  VERSION = "0.1.11"
+end

data/lib/shikigami/view_helpers.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+require "shikigami/bootstrap_button"
+module Shikigami
+  module ViewHelpers
+    def bootstrap_dropdown_toggle(title)
+      content_tag :a, bootstrap_dropdown_toggle_hash do
+        concat title
+        concat content_tag :span, nil, class: "caret"
+      end
+    end
+    alias bs_dd_toggle bootstrap_dropdown_toggle
+
+    def bootstrap_button(action, path, options = {})
+      button = Shikigami::BootstrapButton.new(action, options)
+      link_to t("actions.#{action}"), path, button.options
+    end
+    alias bs_btn bootstrap_button
+
+    def no_data_alert(message = t("warnings.no_data"))
+      content_tag :div, message, class: "alert alert-warning"
+    end
+
+    private
+
+    def bootstrap_dropdown_toggle_hash
+      {
+        "class": "dropdown-toggle",
+        "data-toggle": "dropdown",
+        "role": "button",
+        "aria-haspopup": "true",
+        "aria-expanded": "false",
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: shikigami
+version: !ruby/object:Gem::Version
+  version: 0.1.11
+platform: ruby
+authors:
+- Tsehau Chao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: very early devlopment, use at own risk XD
+email:
+- jodeci@5xruby.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- app/controllers/shikigami/base_controller.rb
+- lib/generators/shikigami/install_generator.rb
+- lib/generators/shikigami/templates/locale.yml
+- lib/shikigami.rb
+- lib/shikigami/bootstrap_button.rb
+- lib/shikigami/engine.rb
+- lib/shikigami/railtie.rb
+- lib/shikigami/version.rb
+- lib/shikigami/view_helpers.rb
+homepage: https://github.com/jodeci/shikigami
+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.6.6
+signing_key: 
+specification_version: 4
+summary: making CRUD apps as brain dead easy as possible
+test_files: []