plug 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6555955e0bb24af43ac0baf3d82f1c59c36a2701
-  data.tar.gz: ecb6287ba37b466b037297ee40fb2f7123409eb1
+  metadata.gz: e17ce17b82f86550c238b434a1524e79de09d603
+  data.tar.gz: 484c4c279b9a86e58b1297581cbd1e2a8537d2b2
 SHA512:
-  metadata.gz: 2f38acfd264f4e10bf41bd3c7556b3ba23149c2b5a58f789086258320a6e3839110c08dc29499b144e33265a42390684af2f72e6317088a259d87c512a33327b
-  data.tar.gz: 780aebfebb76e2dfd0b20866e62765e06d6aa57e656146c560f8259ef1d5d8f3409881576da6cc55f4f42ba44c72e8a2c4f57f9560b629279d0d3616b70bfdca
+  metadata.gz: 736df38bac871297d9680d4a00ba0647cdffc5dfe91f2e2b7a10953bc6d7e18d7f2cb59fa87670fda467b9ef735657aea2fb111b2ac5c22b899cd5c9a0c1cb0c
+  data.tar.gz: f90d239f21f388e90c02b6b780da25ff987c347a86bbbe51854707ce306cd3866c90d207e58881adce76f5a50de238c993f9530e2248477cf049c385791852db

data/README.md

@@ -32,6 +32,7 @@ And run the install generator:
 ```bash
 → rails g plug:install
 → rails g 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
@@ -81,6 +82,15 @@ Add buttons to the config block to perform rake tasks from the plug dashboard
   ]
 ```
 
+### 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
+```
+
 ### Running the tests
 
 ```bash

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

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

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/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

@@ -51,6 +51,7 @@ module Plug
     end
 
     # POST /task
+    # TODO: Move this to a separate controller e.g. `tasks_controller.rb`
     def task_execution
       begin
         require 'rake'

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)
+        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/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,15 @@
+module Plug
+  module Resources
+    class SiteNotice < ActiveResource::Base
+      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,6 @@
+module Plug
+  class SiteNotice < ApplicationRecord
+    include AASM
+    include Plug::Concerns::ModelHelpers
+  end
+end

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

@@ -1,15 +1,15 @@
-.row
-  .column
-    - if notice
-      %p.notice= sanitize(notice)
+- if notice
+  %p.notice= sanitize(notice)
 
-    - if alert
-      %p.alert= sanitize(alert)
+- if alert
+  %p.alert= sanitize(alert)
 
-    .row
-      .column
-        = render partial: 'task', collection: Plug.buttons
+.row
+  .column
+    = render partial: 'task', collection: Plug.buttons
 
+.row
+  .column
     .clearfix
       .float-left
         %h4 Features
@@ -23,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,22 @@
+= 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']
+  .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,6 +1,16 @@
 Plug::Engine.routes.draw do
   root to: 'features#index'
 
-  post '/task', to: 'features#task_execution', as: :task_execution
+  # 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/lib/plug/configuration.rb

@@ -8,7 +8,8 @@ module Plug
       :auth_user,
       :auth_password,
       :allow_delete,
-      :buttons
+      :buttons,
+      :api_path
     ].freeze
 
     attr_accessor *VALID_OPTIONS_KEYS

data/lib/plug/version.rb

@@ -1,3 +1,3 @@
 module Plug
-  VERSION = '0.1.14'
+  VERSION = '0.1.15'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plug
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - Ben
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-04-06 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
@@ -197,6 +211,7 @@ files:
 - 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
@@ -209,12 +224,18 @@ 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/feature.rb
+- app/models/plug/resources/site_notice.rb
+- app/models/plug/site_notice.rb
 - app/views/layouts/plug/application.html.haml
 - app/views/plug/features/_form.html.haml
 - app/views/plug/features/_task.html.haml
@@ -223,9 +244,14 @@ files:
 - 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
 - lib/generators/plug/install_generator.rb
 - lib/generators/plug/templates/plug.rb
 - lib/plug.rb
@@ -254,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Rails engine that can plug/unplug features