smug 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45cb8eb3d75b11d44a888fa799c426385c620c5f
+  data.tar.gz: 4f10d7737c629d5f4d52a57e4bbf601b13f00486
+SHA512:
+  metadata.gz: 9b79eb2a00149c4a9d33d288dfcdb5cb5d7bc44e080697d4979c4ab9587617c4ece4850e35b31db0cb4569c4c3845a33cba5e302ec05e830ffb3972f1f90574a
+  data.tar.gz: a578bdc011764430aa2000c5725997c6fe51e4d214cecba5d02e9da4270469a9b3dd3eb4357ff829f959d6269d1dd68dae74dea54bc83af24088f8a731853574

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smug.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nick Bolt
+
+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,40 @@
+# Smug
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/smug`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smug'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smug
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/smug.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/smug/admin/application.js

@@ -0,0 +1,17 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require bootstrap-sprockets
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/app/assets/stylesheets/smug/admin/application.scss

@@ -0,0 +1,12 @@
+@import "bootstrap-sprockets";
+@import "bootswatch/yeti/variables";
+@import "bootstrap";
+@import "devise_bootstrap_views";
+
+// Bootstrap body padding for fixed navbar
+body { padding-top: 60px; }
+
+@import "bootswatch/yeti/bootswatch";
+
+@import "space";
+@import "list";

data/app/assets/stylesheets/smug/admin/list.scss

@@ -0,0 +1,5 @@
+dl {
+  dd {
+    @extend .mb-2;
+  }
+}

data/app/assets/stylesheets/smug/admin/space.scss

@@ -0,0 +1,7 @@
+$m-base: 10px;
+
+@for $i from 1 through 10 {
+  .mb-#{$i} {
+    margin-bottom: $m-base * $i;
+  }
+}

data/app/controllers/concerns/model_inspection.rb

@@ -0,0 +1,27 @@
+require "active_support/concern"
+
+module  ModelInspection
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def model
+      controller_name.classify.constantize
+    end
+
+    def model_name
+      model.model_name
+    end
+
+    def index_attrs
+      model.persistable_attribute_names - %w{ id updated_at created_at }
+    end
+
+    def show_attrs
+      model.persistable_attribute_names
+    end
+
+    def edit_attrs
+      model.persistable_attribute_names - %w{ id updated_at created_at }
+    end
+  end
+end

data/app/controllers/concerns/route_inspection.rb

@@ -0,0 +1,15 @@
+require "active_support/concern"
+
+module  RouteInspection
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def route_options
+      { only: item_actions }
+    end
+
+    def item_actions
+      [:new, :create, :edit, :update, :destroy, :index]
+    end
+  end
+end

data/app/controllers/smug/admin/base_controller.rb

@@ -0,0 +1,9 @@
+module Smug
+  module Admin
+    class BaseController < ApplicationController
+      layout "smug/admin"
+
+      before_action :authenticate_administrator!
+    end
+  end
+end

data/app/controllers/smug/admin/crud_controller.rb

@@ -0,0 +1,67 @@
+module Smug
+  module Admin
+    class CrudController < BaseController
+      include ModelInspection
+      include RouteInspection
+
+      before_action :find_items, only: :index
+      before_action :find_item, only: [:show, :edit, :update, :destroy]
+
+      def index
+      end
+
+      def show
+      end
+
+      def new
+        @item = NewDecorator.decorate(self.class.model.new)
+      end
+
+      def create
+        @item = self.class.model.new(item_params)
+        if @item.save
+          flash[:notice] = t ".created", default: "Record created"
+          redirect_to [:admin, self.class.model_name.route_key]
+        else
+          @item = NewDecorator.decorate(@item)
+          render action: :new
+        end
+      end
+
+      def edit
+      end
+
+      def update
+        if @item.update(item_params)
+          flash[:notice] = t ".updated", default: "Record updated"
+          redirect_to [:admin, self.class.model_name.route_key]
+        else
+          render :edit
+        end
+      end
+
+      def destroy
+        @item.destroy
+        flash[:notice] = t ".destroyed", default: "Record destroyed"
+        redirect_to [:admin, self.class.model_name.route_key]
+      end
+
+      protected
+
+      def find_items
+        @items = self.class.model.all
+        @items = @items.paginate(page: params[:page])
+        @items = PaginationDecorator.decorate(@items)
+      end
+
+      def find_item
+        @item = self.class.model.find(params[:id])
+        @item = ShowDecorator.decorate(@item)
+      end
+
+      def item_params
+        params.require(self.class.model_name.param_key).permit!
+      end
+    end
+  end
+end

data/app/controllers/smug/admin/dashboards_controller.rb

@@ -0,0 +1,8 @@
+module Smug
+  module Admin
+    class DashboardsController < Smug::Admin::BaseController
+      def show
+      end
+    end
+  end
+end

data/app/controllers/smug/admin/passwords_controller.rb

@@ -0,0 +1,7 @@
+module Smug
+  module Admin
+    class PasswordsController < Devise::PasswordsController
+      layout "smug/admin_no_nav"
+    end
+  end
+end

data/app/controllers/smug/admin/sessions_controller.rb

@@ -0,0 +1,6 @@
+module Smug
+  module Admin
+    class SessionsController < Devise::SessionsController
+    end
+  end
+end

data/app/decorators/smug/admin/decorator.rb

@@ -0,0 +1,25 @@
+
+module Smug
+  module Admin
+    class Decorator < Draper::Decorator
+      delegate_all
+
+      LOCALIZABLE_CLASSES = [Date, ActiveSupport::TimeWithZone]
+      TRUNCATABLE_CLASSES = [String]
+
+      def render_attr(attr)
+        output = model.send(attr)
+
+        if output.class.in?(LOCALIZABLE_CLASSES)
+          return h.l(output)
+        end
+
+        if output.class.in?(TRUNCATABLE_CLASSES)
+          return h.truncate(output, length: 140)
+        end
+
+        output
+      end
+    end
+  end
+end

data/app/decorators/smug/admin/index_decorator.rb

@@ -0,0 +1,6 @@
+module Smug
+  module Admin
+    class IndexDecorator < Decorator
+    end
+  end
+end

data/app/decorators/smug/admin/new_decorator.rb

@@ -0,0 +1,6 @@
+module Smug
+  module Admin
+    class NewDecorator < Decorator
+    end
+  end
+end

data/app/decorators/smug/admin/pagination_decorator.rb

@@ -0,0 +1,13 @@
+module Smug
+  module Admin
+    class PaginationDecorator < Draper::CollectionDecorator
+      delegate :current_page, :per_page, :offset, :total_entries, :total_pages
+
+      def decorator_class
+        # TODO: Need ability to have an item use a different decorator here
+        # easily
+        IndexDecorator
+      end
+    end
+  end
+end

data/app/decorators/smug/admin/show_decorator.rb

@@ -0,0 +1,6 @@
+module Smug
+  module Admin
+    class ShowDecorator < Decorator
+    end
+  end
+end

data/app/models/smug/administrator.rb

@@ -0,0 +1,5 @@
+module Smug
+  class Administrator < ActiveRecord::Base
+    devise :database_authenticatable, :recoverable, :rememberable, :trackable
+  end
+end

data/app/views/layouts/smug/_flash.html.slim

@@ -0,0 +1,4 @@
+- if flash[:notice]
+  .container
+    .alert.alert-info
+      = flash[:notice]

data/app/views/layouts/smug/_nav.html.slim

@@ -0,0 +1,8 @@
+= navbar do
+  = vertical do
+    = link_to 'Home', admin_dashboard_path
+  = horizontal do
+    = nav class: 'navbar-right' do
+      - Smug::Plugin.all.each do |plugin|
+        = link_to plugin.model_name.human(count: 2),
+          [:admin, plugin.route_key]

data/app/views/layouts/smug/admin.html.slim

@@ -0,0 +1,15 @@
+doctype html
+html
+  head
+    meta content=("text/html; charset=UTF-8") http-equiv="Content-Type" /
+    title Admin
+    = stylesheet_link_tag 'smug/admin/application',
+                          media: 'all',
+                          'data-turbolinks-track' => true
+    = javascript_include_tag 'smug/admin/application',
+                             'data-turbolinks-track' => true
+    = csrf_meta_tags
+  body
+    = render "layouts/smug/nav"
+    = render "layouts/smug/flash"
+    = yield

data/app/views/layouts/smug/admin_no_nav.html.slim

@@ -0,0 +1,15 @@
+doctype html
+html
+  head
+    meta content=("text/html; charset=UTF-8") http-equiv="Content-Type" /
+    title Admin
+    = stylesheet_link_tag 'smug/admin/application',
+                          media: 'all',
+                          'data-turbolinks-track' => true
+    = javascript_include_tag 'smug/admin/application',
+                             'data-turbolinks-track' => true
+    = csrf_meta_tags
+  body
+    = render "layouts/smug/flash"
+    .container
+      = yield

data/app/views/smug/admin/crud/_form.html.slim

@@ -0,0 +1,4 @@
+= simple_form_for [:admin, @item.object] do |f|
+  - controller.class.edit_attrs.each do |attr|
+    = f.input attr, hint: :translate
+  = f.button :submit

data/app/views/smug/admin/crud/edit.html.slim

@@ -0,0 +1,8 @@
+.container
+  h1.mb-2.text-center = controller.class.model_name.human
+  .text-center.mb-2
+    = link_to :back do
+      i.glyphicon.glyphicon-arrow-left>
+      = t ".back", default: "Back"
+
+  = render "form"

data/app/views/smug/admin/crud/index.html.slim

@@ -0,0 +1,39 @@
+.container
+  h1.mb-2.text-center
+   = controller.class.model_name.human(count: 2)
+
+  .text-center
+    - if controller.class.item_actions.include?(:new)
+      = link_to t("smug.admin.new", model: controller.class.model_name.human),
+        [:new, :admin, controller.class.model_name.singular_route_key],
+        class: "btn btn-default mb-2"
+
+  table.table.table-striped
+    thead
+      - controller.class.index_attrs.each do |attr|
+        th = controller.class.model.human_attribute_name(attr)
+      - if (controller.class.item_actions && [:edit, :destroy, :show]).any?
+        th
+
+    tbody
+      - @items.each do |item|
+        tr
+          - controller.class.index_attrs.each do |attr|
+            td = item.render_attr(attr)
+          - if (controller.class.item_actions && [:edit, :destroy, :show]).any?
+            td
+              .btn-group
+                - if controller.class.item_actions.include?(:show)
+                  = link_to [:admin, item.object], class: "btn btn-xs btn-default" do
+                    i.glyphicon.glyphicon-eye-open>
+                    = t(".show", default: "Show")
+                - if controller.class.item_actions.include?(:edit)
+                  = link_to [:edit, :admin, item.object], class: "btn btn-xs btn-default" do
+                    i.glyphicon.glyphicon-edit>
+                    = t(".edit", default: "Edit")
+                - if controller.class.item_actions.include?(:destroy)
+                  = link_to [:admin, item.object], class: "btn btn-xs btn-default", method: :delete, data: { confirm: t(".confirm", default: "Are you sure?") }
+                    i.glyphicon.glyphicon-trash>
+                    = t(".destroy", default: "Destroy")
+  .text-center
+    = will_paginate @items, renderer: BootstrapPagination::Rails

data/app/views/smug/admin/crud/new.html.slim

@@ -0,0 +1,8 @@
+.container
+  h1.mb-2.text-center = controller.class.model_name.human
+  .text-center.mb-2
+    = link_to :back do
+      i.glyphicon.glyphicon-arrow-left>
+      = t ".back", default: "Back"
+
+  = render "form"

data/app/views/smug/admin/crud/show.html.slim

@@ -0,0 +1,10 @@
+.container
+  h1.mb-2.text-center = controller.class.model_name.human
+  .text-center.mb-2
+    = link_to :back do
+      i.glyphicon.glyphicon-arrow-left>
+      = t(".back", default: "Back")
+  dl
+    - controller.class.show_attrs.each do |attr|
+      dt = controller.class.model.human_attribute_name(attr)
+      dd = @item.render_attr(attr)

data/app/views/smug/admin/dashboards/show.html.slim

@@ -0,0 +1,2 @@
+.container
+  h1 Hello World

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "smug"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here