plug 0.1.12 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8ff054c84075e1b2e008af464461eb7ad3610a78
-  data.tar.gz: cde21d4902f6045df745f4d67699e09c16ba1aef
+SHA256:
+  metadata.gz: a3e56677db5277835599245727b8f5a1ddc7b089a9261f788971c6de539279cd
+  data.tar.gz: 619eb3d58765d7fe2ae88e0d4cc784ce0df8cea15e2e580ce0228f335da1f175
 SHA512:
-  metadata.gz: 4baea815778c86a46fcc78e001811c1c1a3bb305e035ca8d109670786bb9824e29080503ead8fe4fcd45c50d04ba7e539af9f020fe94cd71b213649786a519b9
-  data.tar.gz: 4220069641d7cb9a1d41949c74477bde938c39543f861d98a387372280727643700db1f196a4ac64342e8e4f4e15cfba32f4c178c29790e605a45a00a4952995
+  metadata.gz: 3993e47bb2626186d6057b0aed81651a3ae46d7daec51b56dfe9a8cfbe0a46c242edfc95a6080cefe651d641092b3e157746df03c2a6595a72e96b9b32bc0a56
+  data.tar.gz: 210f55299e22933f46c48d469fc423ec3b7c85cd8be76d7eddeee93ce96efab89f50f11ed2598d530911eb208057c9c6691114d38beba6ff9425fc6b3fc60386

data/README.md

@@ -31,7 +31,8 @@ And run the install generator:
 
 ```bash
 → rails g plug:install
-→ rails g plug:install:migrations
+→ rails plug:install:migrations
+→ rake plug:install:migrations # For Rails <= 3.x
 → rails db:migrate # Newer version of Rails
 → rake db:migrate # Older version of Rails
 → rails s
@@ -72,6 +73,25 @@ If you have custom HTML for notice, you can pass a block.
 <% end %>
 ```
 
+#### Buttons
+Add buttons to the config block to perform rake tasks from the plug dashboard
+
+```ruby
+  config.buttons = [
+    { label: 'Clear cache', task: 'tmp:cache:clear' }
+  ]
+```
+
+### Creating new migrations
+
+```bash
+→ rails g migration MyAwesomeMigration
+→ rails g model MyModel name:string slug:string:index
+→ rails db:migrate
+→ rails db:migrate RAILS_ENV=test
+→ rake plug:install:migrations # Run this on the app to copy the new migrations
+```
+
 ### Running the tests
 
 ```bash

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

@@ -34,5 +34,8 @@
 
 // Blocks
 @import 'blocks/nav';
+@import 'blocks/menu';
 @import 'blocks/notice';
+@import 'blocks/alert';
 @import 'blocks/state';
+@import 'blocks/task-button';

data/app/assets/stylesheets/plug/blocks/_alert.scss

@@ -0,0 +1,5 @@
+.alert {
+  background: $gallery;
+  border: solid 2px $lipstick;
+  padding: 2rem;
+}

data/app/assets/stylesheets/plug/blocks/_menu.scss

@@ -0,0 +1,11 @@
+.menu {
+  list-style-type: none;
+
+  li {
+    display: inline-block;
+    margin-bottom: 0;
+    margin-top: 1rem;
+    margin-left: 2rem;
+    font-weight: bold;
+  }
+}

data/app/assets/stylesheets/plug/blocks/_task-button.scss

@@ -0,0 +1,3 @@
+.task-button {
+  margin: 0 .5rem;
+}

data/app/assets/stylesheets/plug/variables/_colors.scss

@@ -4,4 +4,5 @@ $pale-sky:      #637381;
 $alabaster:     #f7f7f7;
 $gallery:       #ebebeb;
 $tall-poppy:    #c0392b;
-$jungle-green:  #27ae60;
+$lipstick:      #c70376;
+$jungle-green:  #27ae60;

data/app/controllers/plug/api/api_controller.rb

@@ -0,0 +1,7 @@
+module Plug
+  module Api
+    class ApiController < ActionController::Base
+      protect_from_forgery with: :exception
+    end
+  end
+end

data/app/controllers/plug/api/site_notices_controller.rb

@@ -0,0 +1,21 @@
+require_dependency 'plug/application_controller'
+
+module Plug
+  module Api
+    class SiteNoticesController < ApiController
+      # GET /site_notices.json
+      def index
+        @site_notices = SiteNotice.all
+
+        render json: @site_notices
+      end
+
+      # GET /site_notices/slug.json
+      def show
+        @site_notice = SiteNotice.slug_and_name(params[:slug]).first
+
+        render json: @site_notice
+      end
+    end
+  end
+end

data/app/controllers/plug/features_controller.rb

@@ -50,6 +50,20 @@ module Plug
       redirect_to features_url, notice: 'Feature was successfully destroyed.'
     end
 
+    # POST /task
+    # TODO: Move this to a separate controller e.g. `tasks_controller.rb`
+    def task_execution
+      begin
+        Plug::TaskExecutionService.new(name: params[:task]).call
+      rescue StandardError => e
+        flash[:alert] = e.message
+      else
+        flash[:notice] = "Task: #{params[:task]} has completed"
+      end
+
+      redirect_to root_path
+    end
+
     private
       # Use callbacks to share common setup or constraints between actions.
       def set_feature
@@ -62,7 +76,7 @@ module Plug
         if Rails.version.to_i < 5
           ActiveSupport::HashWithIndifferentAccess.new(params[:feature])
         else
-          params.require(:feature).permit(:name, :description, :state)
+          params.require(:feature).permit(:name, :description, :state, :notice)
         end
       end
   end

data/app/controllers/plug/site_notices_controller.rb

@@ -0,0 +1,69 @@
+require_dependency 'plug/application_controller'
+
+module Plug
+  class SiteNoticesController < ApplicationController
+    if Rails.version.to_i < 5
+      before_filter :set_site_notice, only: [:edit, :update, :destroy]
+    else
+      before_action :set_site_notice, only: [:edit, :update, :destroy]
+    end
+
+    # GET /site_notices
+    def index
+      @site_notices = SiteNotice.all
+    end
+
+    # GET /site_notices/1
+    # def show; end
+
+    # GET /site_notices/new
+    def new
+      @site_notice = SiteNotice.new
+    end
+
+    # GET /site_notices/1/edit
+    def edit; end
+
+    # POST /site_notices
+    def create
+      @site_notice = SiteNotice.new(site_notice_params)
+
+      if @site_notice.save
+        redirect_to site_notices_path, notice: 'Site Notice was successfully created.'
+      else
+        render :new
+      end
+    end
+
+    # PATCH/PUT /site_notices/1
+    def update
+      if @site_notice.update_attributes(site_notice_params)
+        redirect_to site_notices_path, notice: 'Site Notice was successfully updated.'
+      else
+        render :edit
+      end
+    end
+
+    # DELETE /site_notices/1
+    def destroy
+      @site_notice.destroy
+      redirect_to site_notices_url, notice: 'Site Notice was successfully destroyed.'
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_site_notice
+        @site_notice = SiteNotice.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      # TODO: Strong params not available for older Rails
+      def site_notice_params
+        if Rails.version.to_i < 5
+          ActiveSupport::HashWithIndifferentAccess.new(params[:site_notice])
+        else
+          params.require(:site_notice).permit(:name, :notice, :state, :theme)
+        end
+      end
+  end
+end

data/app/models/plug/concerns/model_helpers.rb

@@ -0,0 +1,45 @@
+require 'active_support/concern'
+
+module Plug
+  module Concerns
+    module ModelHelpers
+      extend ActiveSupport::Concern
+
+      included do
+        include AASM
+
+        # Validations
+        validates :name, presence: { message: "#{self.humanized_class_name} name is required" },
+                         uniqueness: { message: "#{self.humanized_class_name} name must be unique", case_sensitive: false }
+        validates :state, presence: { message: "#{self.humanized_class_name} state is required" }
+
+        # Callbacks
+        before_save { self.slug = name.parameterize }
+
+        # Scopes
+        scope :slug_and_name, ->(arg) { where('slug = ? OR name = ?', arg, arg) }
+
+        # States
+        aasm column: :state do
+          state :enabled, initial: true
+          state :disabled
+
+          event :enable do
+            transitions from: :disabled, to: :enabled
+          end
+
+          event :disable do
+            transitions from: :enabled, to: :disabled
+          end
+        end
+
+      end
+
+      module ClassMethods
+        def humanized_class_name
+          self.name.demodulize.underscore.humanize.capitalize
+        end
+      end
+    end
+  end
+end

data/app/models/plug/concerns/themeable.rb

@@ -0,0 +1,16 @@
+require 'active_support/concern'
+
+module Plug
+  module Concerns
+    module Themeable
+      extend ActiveSupport::Concern
+
+      included do
+
+        def icon
+          theme.split(';').last.split(':').last
+        end
+      end
+    end
+  end
+end

data/app/models/plug/feature.rb

@@ -1,30 +1,6 @@
 module Plug
   class Feature < ApplicationRecord
     include AASM
-
-    # Validations
-    validates :name, presence: { message: 'Feature name is required' },
-                     uniqueness: { message: 'Feature name must be unique', case_sensitive: false }
-    validates :state, presence: { message: 'Feature state is required' }
-
-    # Callbacks
-    before_save { self.slug = name.parameterize }
-
-    # Scopes
-    scope :slug_and_name, ->(arg) { where('slug = ? OR name = ?', arg, arg) }
-
-    # States
-    aasm column: :state do
-      state :enabled, initial: true
-      state :disabled
-
-      event :enable do
-        transitions from: :disabled, to: :enabled
-      end
-
-      event :disable do
-        transitions from: :enabled, to: :disabled
-      end
-    end
+    include Plug::Concerns::ModelHelpers
   end
 end

data/app/models/plug/resources/site_notice.rb

@@ -0,0 +1,17 @@
+module Plug
+  module Resources
+    class SiteNotice < ActiveResource::Base
+      include Plug::Concerns::Themeable
+
+      self.site = Plug.api_path
+
+      def enabled?
+        state == 'enabled'
+      end
+
+      def disabled?
+        state == 'disabled'
+      end
+    end
+  end
+end

data/app/models/plug/site_notice.rb

@@ -0,0 +1,7 @@
+module Plug
+  class SiteNotice < ApplicationRecord
+    include AASM
+    include Plug::Concerns::ModelHelpers
+    include Plug::Concerns::Themeable
+  end
+end

data/app/services/plug/task_execution_service.rb

@@ -0,0 +1,18 @@
+require 'rake'
+
+module Plug
+  class TaskExecutionService
+    attr_reader :name
+
+    def initialize(name: nil)
+      raise 'Task name is required' if name.nil?
+
+      @name = name
+    end
+
+    def call
+      Rails.application.load_tasks
+      Rake::Task[name].execute
+    end
+  end
+end

data/app/views/layouts/plug/application.html.haml

@@ -1,5 +1,6 @@
 !!!
 %html{ lang: 'en' }
+  = favicon_link_tag 'favicon.png'
   = render 'plug/shared/head'
 
   %body
@@ -7,4 +8,4 @@
       = render 'plug/shared/nav'
       = yield
 
-    /= render 'shared/footer'
+    /= render 'shared/footer'

data/app/views/plug/features/_task.html.haml

@@ -0,0 +1,4 @@
+.task-button
+  = form_tag(task_execution_path) do
+    = hidden_field_tag(:task, task[:task])
+    = submit_tag(task[:label])

data/app/views/plug/features/index.html.haml

@@ -1,8 +1,15 @@
+- if notice
+  %p.notice= sanitize(notice)
+
+- if alert
+  %p.alert= sanitize(alert)
+
 .row
   .column
-    - if notice
-      %p.notice= notice
+    = render partial: 'task', collection: Plug.buttons
 
+.row
+  .column
     .clearfix
       .float-left
         %h4 Features
@@ -16,6 +23,9 @@
           %th Description
           %th Slug
           %th State
+          
+          - if Plug.allow_delete
+            %th Actions
 
       %tbody
         - @features.each do |feature|

data/app/views/plug/shared/_nav.html.haml

@@ -1,6 +1,9 @@
 %nav.clearfix.nav
-  .row
-    .column
-      %h3
-        = link_to 'Plug', plug.root_path, class: 'nav__logo'
-        %small /unplug features
+  .float-left
+    %h3
+      = link_to 'Plug', plug.root_path, class: 'nav__logo'
+      %small /unplug features
+  .float-right
+    %ul.menu
+      %li= link_to 'Features', plug.root_path
+      %li= link_to 'Site Notices', plug.site_notices_path

data/app/views/plug/site_notices/_form.html.haml

@@ -0,0 +1,25 @@
+= form_for @site_notice do |f|
+  - if @site_notice.errors.any?
+    #error_explanation
+      %h2= "#{pluralize(@site_notice.errors.count, "error")} prohibited this feature from being saved:"
+      %ul
+        - @site_notice.errors.full_messages.each do |message|
+          %li= message
+
+  .field
+    = f.label :name
+    = f.text_field :name
+  .field
+    = f.label :notice
+    = f.text_area :notice, rows: 10
+  .field
+    = f.label :state
+    = f.select :state, ['enabled', 'disabled']
+  .field
+    = f.label :theme
+    = f.select :theme, Plug.themes.map { |theme| [theme[:name], "#{theme[:style].to_a.map { |s| s.join(':') }.join(';')}"] }
+  .actions.clearfix
+    .float-left
+      = link_to 'Back', site_notices_path, class: 'button'
+    .float-right
+      = f.submit 'Save'

data/app/views/plug/site_notices/edit.html.haml

@@ -0,0 +1,5 @@
+.row
+  .column
+    %h4 Editing site notice
+
+    = render 'form'

data/app/views/plug/site_notices/index.html.haml

@@ -0,0 +1,41 @@
+.row
+  .column
+    - if notice
+      %p.notice= sanitize(notice)
+
+    - if alert
+      %p.alert= sanitize(alert)
+
+    .clearfix
+      .float-left
+        %h4 Site Notices
+      .float-right
+        = link_to 'New Site Notice', new_site_notice_path, class: 'button'
+
+    %table
+      %thead
+        %tr
+          %th Name
+          %th Notice
+          %th Slug
+          %th State
+          
+          - if Plug.allow_delete
+            %th Actions
+
+      %tbody
+        - @site_notices.each do |site_notice|
+          %tr
+            %td= link_to site_notice.name, edit_site_notice_path(site_notice), class: 'strong'
+            %td= site_notice.notice
+            %td= site_notice.slug
+            %td
+              - if site_notice.state == 'enabled'
+                %i.fas.fa-check-circle.fa-2x.state__enabled
+              - else
+                %i.fas.fa-times-circle.fa-2x.state__disabled
+
+            - if Plug.allow_delete
+              %td= link_to 'Destroy', site_notice, method: :delete, data: { confirm: 'Are you sure?' }
+
+    

data/app/views/plug/site_notices/new.html.haml

@@ -0,0 +1,7 @@
+.row
+  .column
+    .clearfix
+      .float-left
+        %h4 New site notice
+
+    = render 'form'

data/config/routes.rb

@@ -1,5 +1,16 @@
 Plug::Engine.routes.draw do
   root to: 'features#index'
 
+  # Features
   resources :features, except: :show
+
+  # Site notices
+  resources :site_notices, except: :show
+
+  namespace :api, defaults: { format: :json } do
+    get '/site_notices/:slug', to: 'site_notices#show'
+    get '/site_notices', to: 'site_notices#index'
+  end
+
+  post '/task', to: 'features#task_execution', as: :task_execution
 end

data/db/migrate/20180403024712_create_plug_site_notices.rb

@@ -0,0 +1,15 @@
+class CreatePlugSiteNotices < ActiveRecord::Migration
+  def change
+    create_table :plug_site_notices do |t|
+      t.string :name
+      t.string :slug
+      t.text :notice
+      t.string :state
+
+      t.timestamps
+    end
+
+    add_index :plug_site_notices, :name
+    add_index :plug_site_notices, :slug
+  end
+end

data/db/migrate/20180424015828_add_theme_to_plug_site_notice.rb

@@ -0,0 +1,5 @@
+class AddThemeToPlugSiteNotice < ActiveRecord::Migration[5.1]
+  def change
+    add_column :plug_site_notices, :theme, :string
+  end
+end

data/lib/plug/configuration.rb

@@ -7,7 +7,10 @@ module Plug
     VALID_OPTIONS_KEYS = [
       :auth_user,
       :auth_password,
-      :allow_delete
+      :allow_delete,
+      :buttons,
+      :api_path,
+      :themes
     ].freeze
 
     attr_accessor *VALID_OPTIONS_KEYS

data/lib/plug/version.rb

@@ -1,3 +1,3 @@
 module Plug
-  VERSION = '0.1.12'
+  VERSION = '0.1.19'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plug
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.19
 platform: ruby
 authors:
 - Ben
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2020-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.4
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.4
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sass-rails
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -191,13 +205,17 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/plug_manifest.js
+- app/assets/images/favicon.png
 - app/assets/javascripts/plug/application.js
 - app/assets/javascripts/plug/features.js
 - app/assets/stylesheets/plug/_settings.scss
 - app/assets/stylesheets/plug/application.scss
+- app/assets/stylesheets/plug/blocks/_alert.scss
+- app/assets/stylesheets/plug/blocks/_menu.scss
 - app/assets/stylesheets/plug/blocks/_nav.scss
 - app/assets/stylesheets/plug/blocks/_notice.scss
 - app/assets/stylesheets/plug/blocks/_state.scss
+- app/assets/stylesheets/plug/blocks/_task-button.scss
 - app/assets/stylesheets/plug/foundation_and_overrides.scss
 - app/assets/stylesheets/plug/milligram.scss
 - app/assets/stylesheets/plug/mixins/_bem.scss
@@ -206,22 +224,37 @@ files:
 - app/assets/stylesheets/plug/partials/_utils.scss
 - app/assets/stylesheets/plug/variables/_colors.scss
 - app/assets/stylesheets/plug/variables/_typography.scss
+- app/controllers/plug/api/api_controller.rb
+- app/controllers/plug/api/site_notices_controller.rb
 - app/controllers/plug/application_controller.rb
 - app/controllers/plug/features_controller.rb
+- app/controllers/plug/site_notices_controller.rb
 - app/helpers/plug/application_helper.rb
 - app/mailers/plug/application_mailer.rb
 - app/models/plug/application_record.rb
+- app/models/plug/concerns/model_helpers.rb
+- app/models/plug/concerns/themeable.rb
 - app/models/plug/feature.rb
+- app/models/plug/resources/site_notice.rb
+- app/models/plug/site_notice.rb
+- app/services/plug/task_execution_service.rb
 - app/views/layouts/plug/application.html.haml
 - app/views/plug/features/_form.html.haml
+- app/views/plug/features/_task.html.haml
 - app/views/plug/features/edit.html.haml
 - app/views/plug/features/index.html.haml
 - app/views/plug/features/new.html.haml
 - app/views/plug/shared/_head.html.haml
 - app/views/plug/shared/_nav.html.haml
+- app/views/plug/site_notices/_form.html.haml
+- app/views/plug/site_notices/edit.html.haml
+- app/views/plug/site_notices/index.html.haml
+- app/views/plug/site_notices/new.html.haml
 - config/routes.rb
 - db/migrate/20171207020316_create_plug_features.rb
 - db/migrate/20180128202026_add_notice_to_plug_features.rb
+- db/migrate/20180403024712_create_plug_site_notices.rb
+- db/migrate/20180424015828_add_theme_to_plug_site_notice.rb
 - lib/generators/plug/install_generator.rb
 - lib/generators/plug/templates/plug.rb
 - lib/plug.rb
@@ -249,8 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Rails engine that can plug/unplug features