carload 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f8cf9b142c5e13784ccffe393d2d9645655887f
+  data.tar.gz: 0aa2c2d084dd387f84f40e6f6aae4019257e7fe2
+SHA512:
+  metadata.gz: a7850af28727246a420c16a7cda6bc024b46c22350784e4f7197c0e1801ad8b0cb3c14b4480e7163d7f86d8ca53d6406cd1a80180bd5e9f88d445f3e3df5534d
+  data.tar.gz: e1198767a2f476a07434960bec5c83386eb88f69f31d489ed06690accace7da7413494145dc06067054ff0910e804fd1b243b76695fdacb09323195120772949

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Li Dong
+
+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,125 @@
+# Carload
+This is another dashboard gem for Rails (see [Rails Admin], [ActiveAdmin] and [Administrate]). Carload tries to reduce the typing when implement a dashboard, but it also allow developer to realize any page view if they like.
+
+[Rails Admin]: https://github.com/sferik/rails_admin
+[ActiveAdmin]: http://activeadmin.info/
+[Administrate]: https://github.com/thoughtbot/administrate
+
+DEMO: [https://carload-demo.herokuapp.com/carload/dashboard/](https://carload-demo.herokuapp.com/carload/dashboard/)
+
+![](http://7xvqi7.com1.z0.glb.clouddn.com/carload.dashboard.snapshot.zh-CN.png)
+
+## Usage
+- Run `rails g carload:install` to mount engine routes, add require statement and add initializer.
+
+You can edit the initializer `config/initializers/carload.rb` for example:
+
+```ruby
+Carload.setup do |config|
+  # Specify which authentication solution is used. Currently, we only support Devise.
+  config.auth_solution = :devise
+
+  # Set the actions used to discern user's permission to access dashboard.
+  #
+  #   config.dashboard.permits_user.<method> = '...'
+  #
+  # There are four access methods can be configured:
+  #
+  #   index, new, edit, destroy
+  #
+  # Also you can use a special method 'all' to set the default permission.
+  # The permission can also be array, the relation among them is OR.
+  # By doing this, you have full control on the access permission.
+  # TODO: Set the permissions for each data table.
+  config.dashboard.permits_user.all = 'role.admin?'
+end
+```
+
+- Run `rails g carload:dashboard` to generate `app/carload/dashboard.rb`, and edit that file for example:
+
+```ruby
+# Dashboard class is used to tell Carload what models are needed to administrated,
+# which attributes are shown, etc.
+
+class Dashboard < Carload::Dashboard
+  # There are two DSL block types:
+  #
+  #   model :<model_name> do |spec|
+  #     # Whether model should be displayed when URL does not specify one
+  #     spec.default = <true_or_false>
+  #     # List of attributes that can be edited
+  #     spec.attributes.permitted = [...]
+  #     # List of attributes that will be shown on index page
+  #     spec.index_page.shows.attributes = [...]
+  #     # List of attributes with search terms that can be searched on index page (using Ransack gem)
+  #     spec.index_page.searches.attributes = [ { name: ..., term: ...}, ... ]
+  #   end
+  #
+  #   associate :<model_name_a> => :<model_name_b>, choose_by: :<attribute_in_model_b>
+
+  model :product do |spec|
+    spec.default = true
+    spec.attributes.permitted = [ :name ]
+    spec.index_page.shows.attributes = [ :name ]
+    spec.index_page.searches.attributes = [
+      { name: :name, term: :cont }
+    ]
+  end
+  model :item do |spec|
+    spec.attributes.permitted = [ :name, :product_id ]
+    spec.index_page.shows.attributes = [ :name, 'product.name' ]
+    spec.index_page.searches.attributes = [
+      { name: :name, term: :cont },
+      { name: 'product.name', term: :cont }
+    ]
+  end
+  associate :item => :product, choose_by: :name
+end
+```
+
+- Make sure you have the necessary I18n translation files, for example:
+
+```yaml
+en:
+  activerecord:
+    models:
+      item: Item
+    attributes:
+      item:
+        name: Name
+        product:
+          name: Product Name
+```
+```yaml
+en:
+  activerecord:
+    models:
+      product: Product
+    attributes:
+      product:
+        name: Name
+```
+- Access the brand new dashboard in '<Your URL>/carload'.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'carload'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install carload
+```
+
+## 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,37 @@
+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    = 'Carload'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/carload_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/carload .js
+//= link_directory ../stylesheets/carload .css

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

@@ -0,0 +1,5 @@
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require bootstrap-sprockets
+//= require_tree .

data/app/assets/javascripts/carload/dashboard.js

@@ -0,0 +1,12 @@
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require bootstrap-sprockets
+//= require select2
+//= require_tree .
+
+$(document).on('turbolinks:load', function() {
+  $('.use-select2').select2({
+    placeholder: $(this).data('placeholder')
+  })
+})

data/app/assets/stylesheets/carload/_select2.scss

@@ -0,0 +1,13 @@
+.select2-selection, .select2-selection__arrow {
+  height: 34px !important;
+}
+.select2-selection__rendered {
+  line-height: 34px !important;
+}
+
+.select2-selection {
+  border-color: #ccc !important;
+}
+.select2-results__option--highlighted {
+  background-color: $main-color !important;
+}

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

@@ -0,0 +1,25 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require font-awesome
+ *= require select2
+ *= require select2-bootstrap
+ */
+
+$spacing: 16px;
+
+@import 'bootstrap-sprockets';
+@import 'bootstrap';
+
+@import 'colors';
+@import 'common';
+@import 'error';

data/app/assets/stylesheets/carload/colors.scss

@@ -0,0 +1,2 @@
+$main-color: #8C7DA6;
+$text-color: #3F3F44;

data/app/assets/stylesheets/carload/common.scss

@@ -0,0 +1,77 @@
+body {
+  color: $text-color;
+}
+
+a {
+  color: $main-color;
+}
+a:hover {
+  color: $main-color;
+  text-decoration: none;
+}
+
+th {
+  color: $main-color;
+}
+
+.panel {
+  border-color: $main-color;
+}
+.panel-danger {
+  border-color: #ddd;
+  .panel-heading {
+    color: white;
+    text-shadow: 0 -1px 0 #900;
+    background-color: #df3e3e;
+  }
+}
+
+.pagination {
+  li > a {
+    color: $main-color;
+    border-color: $main-color;
+  }
+  li > a:hover {
+    color: $main-color;
+    background-color: lighten($main-color, 20%);
+    border-color: lighten($main-color, 20%);
+  }
+  li.active > a {
+    background-color: $main-color;
+    border-color: $main-color;
+  }
+  li.active > a:hover {
+    background-color: lighten($main-color, 20%);;
+    border-color: lighten($main-color, 20%);
+  }
+}
+
+.center {
+  text-align: center;
+}
+
+.btn-primary {
+  color: #fff;
+  text-shadow: 0 -1px 0 rgba(0,0,0,0.15);
+  background-color: #60b044;
+  background-image: -webkit-linear-gradient(#8add6d, #60b044);
+  background-image: linear-gradient(#8add6d, #60b044);
+  border-color: #5ca941;
+}
+.btn-primary:hover {
+  color: #fff;
+  background-color: #569e3d;
+  background-image: -webkit-linear-gradient(#79d858, #569e3d);
+  background-image: linear-gradient(#79d858, #569e3d);
+  border-color: #4a993e;
+}
+
+.form-control:hover {
+  border-color: $main-color;
+}
+
+:focus {
+  outline-color: $main-color;
+  border-color: $main-color !important;
+  box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px $main-color !important;
+}

data/app/assets/stylesheets/carload/dashboard.scss

@@ -0,0 +1,82 @@
+//= require font-awesome
+//= require select2
+//= require select2-bootstrap
+
+$spacing: 16px;
+
+@import 'bootstrap-sprockets';
+@import 'bootstrap';
+
+@import 'colors';
+@import 'common';
+@import '_select2';
+
+#top-nav-buttons {
+  position: fixed;
+  top: 0;
+  width: 100%;
+  z-index: 1000;
+  a:first-child {
+    border-top-left-radius: 0;
+  }
+  a:last-child {
+    border-top-right-radius: 0;
+  }
+  a {
+    border-color: $main-color;
+  }
+  a:hover {
+    background-color: lighten($main-color, 20%);
+    border-color: lighten($main-color, 20%);
+  }
+  a.active {
+    background-color: $main-color;
+    color: white;
+  }
+  a.active:hover {
+    background-color: lighten($main-color, 20%);
+    border-color: lighten($main-color, 20%);
+  }
+}
+
+#main-container {
+  width: 100%;
+  #main-content {
+    margin-top: 50px;
+  }
+}
+
+.model-index-panel {
+  width: 100%;
+  table {
+    margin-bottom: 0;
+  }
+}
+.model-new-panel, .model-edit-panel {
+  max-width: 600px;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+#dashboard-index-buttons {
+  display: inline-block;
+  margin-right: $spacing;
+}
+#new_q {
+  display: inline-block;
+}
+
+.search-fields {
+  display: inline-flex;
+  .form-group {
+    display: inline-flex;
+    margin-right: 5px;
+    margin-bottom: 0;
+  }
+  .form-group:last-child {
+    margin-right: 0;
+  }
+}
+.search-buttons {
+  display: inline-flex;
+}

data/app/assets/stylesheets/carload/error.scss

@@ -0,0 +1,4 @@
+.error-panel {
+  max-width: 600px;
+  margin: $spacing auto $spacing auto;
+}

data/app/controllers/carload/application_controller.rb

@@ -0,0 +1,21 @@
+module Carload
+  class ApplicationController < ::ApplicationController
+    include Pundit
+    rescue_from Pundit::NotAuthorizedError, with: :rescue_not_authorized_error
+
+    protect_from_forgery with: :exception
+
+    private
+
+    def rescue_not_authorized_error
+      if Carload.auth_solution == :devise
+        if user_signed_in?
+          message = I18n.t("carload.error.message.#{params[:controller].split('/').last}_#{params[:action]}")
+          redirect_to unauthorized_error_path(message: message)
+        else
+          authenticate_user!
+        end
+      end
+    end
+  end
+end

data/app/controllers/carload/dashboard_controller.rb

@@ -0,0 +1,85 @@
+require_dependency 'carload/application_controller'
+
+module Carload
+  class DashboardController < ApplicationController
+    layout 'carload/dashboard'
+    rescue_from ActionView::MissingTemplate, with: :rescue_missing_template
+    rescue_from Carload::UnmanagedModelError, with: :rescue_unmanaged_model_error
+
+    before_action :set_model
+    before_action :set_object, only: [:edit, :update, :destroy]
+
+    def index
+      authorize :dashboard, :index? unless Carload.auth_solution == :none
+      @search = @model_class.search(params[:q])
+      @objects = @search.result.page(params[:page])
+      @show_attributes = Dashboard.model(@model_name).index_page[:shows][:attributes] + [:created_at, :updated_at]
+      @search_attributes = Dashboard.model(@model_name).index_page[:searches][:attributes]
+      render "dashboard/#{@model_names}/index.html.erb"
+    end
+
+    def new
+      authorize :dashboard, :new? unless Carload.auth_solution == :none
+      @object = @model_class.new
+    end
+
+    def edit
+      authorize :dashboard, :edit? unless Carload.auth_solution == :none
+    end
+
+    def create
+      authorize :dashboard, :create? unless Carload.auth_solution == :none
+      @object = @model_class.create model_params
+      if @object.save
+        redirect_to action: :index, model: @model_names # TODO: To show page.
+      else
+        render :new
+      end
+    end
+
+    def update
+      authorize :dashboard, :update? unless Carload.auth_solution == :none
+      if @object.update model_params
+        redirect_to action: :index, model: @model_names # TODO: To show page.
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      authorize :dashboard, :destroy? unless Carload.auth_solution == :none
+      @object.destroy
+      redirect_to action: :index, model: @model_names
+    end
+
+    def search
+      params[:action] = :index # To make rescue_missing_template use correct index action.
+      index
+    end
+
+    private
+
+    def set_model
+      @model_names = ( params[:model] || Dashboard.default_model ).to_s.pluralize
+      @model_name = @model_names.singularize.to_sym
+      raise Carload::UnmanagedModelError.new(@model_name) if not Dashboard.models.keys.include? @model_name
+      @model_class = @model_name.to_s.classify.constantize
+    end
+
+    def set_object
+      @object = @model_class.find params[:id]
+    end
+
+    def model_params
+      params.require(@model_name).permit(Dashboard.model(@model_name).attributes[:permitted])
+    end
+
+    def rescue_missing_template exception
+      render params[:action]
+    end
+
+    def rescue_unmanaged_model_error exception
+      redirect_to dashboard_error_path(message: exception.message)
+    end
+  end
+end

data/app/controllers/carload/errors_controller.rb

@@ -0,0 +1,21 @@
+require_dependency 'carload/application_controller'
+
+module Carload
+  class ErrorsController < ApplicationController
+    layout 'carload/application'
+
+    before_action :set_message
+
+    def dashboard_error
+    end
+
+    def unauthorized_error
+    end
+
+    private
+
+    def set_message
+      @message = params[:message]
+    end
+  end
+end

data/app/helpers/carload/application_helper.rb

@@ -0,0 +1,4 @@
+module Carload
+  module ApplicationHelper
+  end
+end

data/app/helpers/carload/dashboard_helper.rb

@@ -0,0 +1,30 @@
+module Carload
+  module DashboardHelper
+    def generate_input form, model_name, attribute_name, column
+      if column.type == :integer and attribute_name =~ /_id/
+        associated_model = attribute_name.sub('_id', '')
+        label_attribute = Dashboard.model(model_name).associated_models[associated_model.to_sym]
+        form.association associated_model,
+          label_method: label_attribute,
+          label: t("activerecord.models.#{associated_model}"),
+          input_html: {
+            class: 'use-select2',
+            data: {
+              placeholder: t('carload.placeholder.select', thing: t("activerecord.attributes.#{associated_model}.#{label_attribute}"))
+            }
+          }
+      else
+        form.input attribute_name
+      end
+    end
+
+    def generate_show object, attribute
+      case attribute
+      when Symbol
+        object.send attribute
+      when String
+        eval "object.#{attribute}"
+      end
+    end
+  end
+end

data/app/jobs/carload/application_job.rb

@@ -0,0 +1,4 @@
+module Carload
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/carload/application_mailer.rb

@@ -0,0 +1,6 @@
+module Carload
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/carload/application_record.rb

@@ -0,0 +1,5 @@
+module Carload
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/policies/application_policy.rb

@@ -0,0 +1,53 @@
+class ApplicationPolicy
+  attr_reader :user, :record
+
+  def initialize(user, record)
+    @user = user
+    @record = record
+  end
+
+  def index?
+    false
+  end
+
+  def show?
+    scope.where(:id => record.id).exists?
+  end
+
+  def create?
+    false
+  end
+
+  def new?
+    create?
+  end
+
+  def update?
+    false
+  end
+
+  def edit?
+    update?
+  end
+
+  def destroy?
+    false
+  end
+
+  def scope
+    Pundit.policy_scope!(user, record.class)
+  end
+
+  class Scope
+    attr_reader :user, :scope
+
+    def initialize(user, scope)
+      @user = user
+      @scope = scope
+    end
+
+    def resolve
+      scope
+    end
+  end
+end

data/app/policies/dashboard_policy.rb

@@ -0,0 +1,21 @@
+class DashboardPolicy < Struct.new(:user, :dashboard)
+  [:index, :new, :edit, :destroy].each do |action|
+    define_method :"#{action}?" do
+      return true if Carload.auth_solution == :none
+      return false if not user
+      action = :all if not Carload.dashboard[:permits_user][action]
+      Array(Carload.dashboard[:permits_user][action]).each do |permission|
+        return true if eval "user.#{permission}"
+      end
+      false
+    end
+  end
+
+  def create?
+    new?
+  end
+
+  def update?
+    edit?
+  end
+end