lotus_admin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8db608db954a0263ed08e5b450a4e6857143319
+  data.tar.gz: '09320de0916f85e8612710f3821f55738d40c8e1'
+SHA512:
+  metadata.gz: 31474451eae9ea44c0f188210679c8c26583779ea436b5b95e882f28b1f8f16cf168def36a82df318078037ef78865d0d71b102252d0afc938cf5eddf0c8475b
+  data.tar.gz: 77762962f586a912732d82095a6047aa641836459ea5de06d4ecadb7bc8a87cc086b00291648be0c86501b7cb49f3e39f16eef5cbcc43aa5fd35f59f33e969c4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Matt Millsaps-Brewer
+
+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,63 @@
+# Lotus Admin
+Provides a simple, Bootstrap 3 Material Design UI to administer your web app.
+
+[ ![Codeship Status for madebylotus/lotus-admin](https://app.codeship.com/projects/df7c4300-feb0-0135-4b73-065227294bbd/status?branch=master)](https://app.codeship.com/projects/279526)
+
+## Usage
+Install and subclass any controllers, models, or views as needed.
+
+## Installation
+Add this line to your application's Gemfile and then mount the engine in your application.
+
+### Requirements
+* Ruby 2.4
+* Rails 5
+
+### Required Secrets
+You will need to define these secrets.
+
+* `action_mailer_default_sender_address`
+
+### Setup
+
+```ruby
+# Gemfile
+gem 'lotus_admin', '~> 0.1.0'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Add to your routes
+```ruby
+# config/routes.rb
+mount LotusAdmin::Engine, at: 'admin'
+```
+
+Seed an administrator account, optional.
+
+```
+$> rake lotus_admin:seed
+```
+
+You can now login at [http://localhost:3000/admin](http://localhost:3000/admin).
+
+## Contributing
+Contribution directions go here.
+
+## Testing
+
+```shell
+$> bundle exec rspec spec
+```
+
+You can run the included test rails app as well:
+
+```shell
+$> cd spec/dummy && rails s
+```
+
+## 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,20 @@
+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    = 'LotusAdmin'
+  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/config/lotus_admin_manifest.js

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

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

@@ -0,0 +1,5 @@
+//= require jquery
+//= require jquery_ujs
+//= require bootstrap-sprockets
+
+//= require lotus_admin/theme/app

data/app/assets/stylesheets/lotus_admin/application.css.scss

@@ -0,0 +1,9 @@
+@import "lotus_admin/theme/inc/variables";
+
+$footer-height: 70px;
+
+@import "bootstrap";
+@import "font-awesome";
+@import "lotus_admin/theme/app";
+
+@import "lotus_admin/components/all";

data/app/assets/stylesheets/lotus_admin/components/_alerts.scss

@@ -0,0 +1,5 @@
+.alert {
+  &.alert-danger, &.alert-warning, &.alert-success, &.alert-info, &.alert-primary {
+    color: white;
+  }
+}

data/app/assets/stylesheets/lotus_admin/components/_all.scss

@@ -0,0 +1,4 @@
+@import "lotus_admin/components/alerts";
+@import "lotus_admin/components/devise";
+@import "lotus_admin/components/forms";
+@import "lotus_admin/components/tables";

data/app/assets/stylesheets/lotus_admin/components/_devise.scss

@@ -0,0 +1,3 @@
+.devise-shared-links-container {
+  margin-top: 25px;
+}

data/app/assets/stylesheets/lotus_admin/components/_forms.scss

@@ -0,0 +1,7 @@
+.form-actions {
+  .btn.waves-effect {
+    i.zmdi, i.fa {
+      margin-left: 5px;
+    }
+  }
+}

data/app/assets/stylesheets/lotus_admin/components/_tables.scss

@@ -0,0 +1,27 @@
+table.table {
+  .actions-col {
+    text-align: right;
+    .btn {
+      margin-left: 5px;
+
+      &:first-child {
+        margin-left: 0px;
+      }
+    }
+  }
+
+  td.avatar {
+    width: 60px !important;
+    padding: 13px 0 0 15px !important;
+  }
+
+  tr.with-avatar {
+    td:not(.avatar) {
+      padding-top: 27px;
+
+      @media(max-width: $screen-sm) {
+        padding-top: 18px;
+      }
+    }
+  }
+}

data/app/controllers/concerns/lotus_admin/devise_controllers.rb

@@ -0,0 +1,7 @@
+module LotusAdmin::DeviseControllers
+  extend ActiveSupport::Concern
+
+  included do
+    layout 'lotus_admin/devise'
+  end
+end

data/app/controllers/concerns/lotus_admin/exposure.rb

@@ -0,0 +1,27 @@
+module LotusAdmin
+  module Exposure
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def let(attribute_name, &block)
+
+        # instance setter method
+        define_method("#{ attribute_name }=") do |value|
+          instance_variable_set("@#{ attribute_name }", value)
+        end
+
+        # instance method to meomize the block result
+        define_method(attribute_name) do
+          instance_variable_get("@#{ attribute_name }") || begin
+            value = instance_eval(&block)
+            public_send("#{ attribute_name }=", value)
+
+            value
+          end
+        end
+        helper_method(attribute_name)
+
+      end
+    end
+  end
+end

data/app/controllers/concerns/lotus_admin/permitted_params.rb

@@ -0,0 +1,18 @@
+module LotusAdmin
+  module PermittedParams
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def permit_params(*args, &block)
+        define_method :permitted_params do
+          base_params = params.require(resource_class.model_name.singular_route_key)
+          if block.present?
+            block.call(base_params)
+          else
+            base_params.permit(args)
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/lotus_admin/application_controller.rb

@@ -0,0 +1,20 @@
+module LotusAdmin
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    include Exposure
+
+    helper LotusAdmin::ApplicationHelper
+    helper LotusAdmin::FormHelpers
+    helper LotusAdmin::LinkHelpers
+    helper LotusAdmin::PaginationHelpers
+    helper LotusAdmin::PanelHelpers
+    helper LotusAdmin::SidebarHelpers
+
+    private
+
+    def paginate(collection)
+      collection.page(params[:page])
+    end
+  end
+end

data/app/controllers/lotus_admin/authenticated_controller.rb

@@ -0,0 +1,20 @@
+class LotusAdmin::AuthenticatedController < LotusAdmin::ApplicationController
+  include LotusAdmin::PermittedParams
+
+  before_action :authenticate_administrator!
+  around_action :use_user_time_zone, if: :administrator_signed_in?
+
+  let(:menu_identifier) do
+    action = :index
+    action = :new if %w(new create).include?(action_name)
+    action = :edit if %w(edit update).include?(action_name)
+
+    [controller_name, action].join('_').to_sym
+  end
+
+  private
+
+  def use_user_time_zone(&block)
+    Time.use_zone(current_administrator.time_zone, &block)
+  end
+end

data/app/controllers/lotus_admin/confirmations_controller.rb

@@ -0,0 +1,3 @@
+class LotusAdmin::ConfirmationsController < Devise::ConfirmationsController
+  include LotusAdmin::DeviseControllers
+end

data/app/controllers/lotus_admin/dashboard_controller.rb

@@ -0,0 +1,5 @@
+module LotusAdmin
+  class DashboardController < LotusAdmin::AuthenticatedController
+    let(:menu_identifier) { :dashboard_show }
+  end
+end

data/app/controllers/lotus_admin/passwords_controller.rb

@@ -0,0 +1,3 @@
+class LotusAdmin::PasswordsController < Devise::PasswordsController
+  include LotusAdmin::DeviseControllers
+end

data/app/controllers/lotus_admin/profiles_controller.rb

@@ -0,0 +1,20 @@
+module LotusAdmin
+  class ProfilesController < LotusAdmin::AuthenticatedController
+    let(:resource_class) { LotusAdmin::User }
+
+    permit_params do |params|
+      params.permit(:first_name, :last_name, :email, :time_zone, :password, :password_confirmation).delete_if do |k,v|
+        k.start_with?('password') && v.blank?
+      end
+    end
+
+    def update
+      if current_administrator.update(permitted_params)
+        bypass_sign_in(current_administrator, scope: :administrator)
+        redirect_to lotus_admin.root_path, notice: 'Changes to your profile have been saved'
+      else
+        render :edit
+      end
+    end
+  end
+end

data/app/controllers/lotus_admin/sessions_controller.rb

@@ -0,0 +1,3 @@
+class LotusAdmin::SessionsController < Devise::SessionsController
+  include LotusAdmin::DeviseControllers
+end

data/app/controllers/lotus_admin/users_controller.rb

@@ -0,0 +1,45 @@
+module LotusAdmin
+  class UsersController < LotusAdmin::AuthenticatedController
+    let(:menu_identifier) { :users_index }
+    let(:resource_class) { LotusAdmin::User }
+    let(:users) { paginate(resource_class.all) }
+    let(:user) { resource_class.find(params[:id]) }
+
+    permit_params :first_name, :last_name, :email, :time_zone
+
+    def new
+      self.user = resource_class.new
+    end
+
+    def create
+      self.user = resource_class.new(permitted_params)
+      user.password = Devise.friendly_token.first(8)
+
+      if user.save
+        user.send_invited_email_notification
+
+        redirect_to [lotus_admin, resource_class], notice: "Created new #{ resource_class.model_name.human }"
+      else
+        render :new
+      end
+    end
+
+    def update
+      if user.update(permitted_params)
+        redirect_to [lotus_admin, user], notice: 'Changes saved'
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      if user.destroy
+        flash[:notice] = "#{ resource_class.model_name.human } has been removed"
+      else
+        flash[:error] = "There was an error removing that #{ resource_class.model_name.human }"
+      end
+
+      redirect_to [lotus_admin, resource_class]
+    end
+  end
+end

data/app/helpers/lotus_admin/application_helper.rb

@@ -0,0 +1,18 @@
+module LotusAdmin
+  module ApplicationHelper
+    def body_class(*extra)
+      [controller_name, action_name.parameterize].concat(extra)
+    end
+
+    def flash_message(message, type='alert')
+      css_class = case type.to_sym
+      when :alert then 'alert-alert alert-warning'
+      when :error then 'alert-error alert-danger'
+      when :notice then 'alert-success alert-notice'
+      when :info then 'alert-info'
+      end
+
+      content_tag(:div, message, class: "alert #{css_class}")
+    end
+  end
+end

data/app/helpers/lotus_admin/form_helpers.rb

@@ -0,0 +1,25 @@
+module LotusAdmin
+  module FormHelpers
+    def material_form_for(resource, options = {}, &block)
+      options[:wrapper] = :material_form
+      options[:wrapper_mappings] = {
+        boolean: :material_boolean_horizontal
+      }
+
+      simple_form_for(resource, options, &block)
+    end
+
+    def material_form_submit(resource)
+      label = "Create #{ resource.class.model_name.human }"
+      label = "Save Changes" if resource.persisted?
+
+      button_tag class: 'btn btn-success' do
+        label.html_safe + content_tag(:i, nil, class: 'zmdi zmdi-arrow-forward')
+      end
+    end
+
+    def material_form_cancel(path)
+      link_to 'Cancel', path, class: 'btn btn-link'
+    end
+  end
+end

data/app/helpers/lotus_admin/link_helpers.rb

@@ -0,0 +1,27 @@
+module LotusAdmin
+  module LinkHelpers
+    def view_link(resource)
+      link_to lotus_admin.polymorphic_path(resource) do
+        content_tag(:i, nil, class: 'zmdi zmdi-eye')
+      end
+    end
+
+    def new_link
+      link_to lotus_admin.new_polymorphic_path(resource_class) do
+        content_tag(:i, nil, class: 'zmdi zmdi-plus-circle')
+      end
+    end
+
+    def edit_link(resource)
+      link_to lotus_admin.edit_polymorphic_path(resource) do
+        content_tag(:i, nil, class: 'zmdi zmdi-edit')
+      end
+    end
+
+    def destroy_link(resource)
+      link_to lotus_admin.polymorphic_path(resource), data: { method: :delete, confirm: "Are you sure you want to remove this #{ resource.model_name.human }?" } do
+        content_tag(:i, nil, class: 'zmdi zmdi-delete')
+      end
+    end
+  end
+end