stenographer-rails 0.6.5 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44f6a0e4fe7106a40fcd994f15d5864d60643c123fb197b06ac2b208080a4c21
-  data.tar.gz: f915d3084e372cb759c1e8774f6dd75e7fd614d136713a34e1b783c893b4af5a
+  metadata.gz: e1bc2c77c61de8c6c527defa8dd115feca280188b5930506fa4ca7a1efd357b6
+  data.tar.gz: 66610d82bfc775102e211715a9437ab8fb691a16d0d79afa96276e2746197fd3
 SHA512:
-  metadata.gz: 9502dcbac8fcf9177557c98a0af798269139c49ec6310d6a7194d13e26cb93fe0b5f272a0f03af622107dd6ae911f0bebc054f0a6987d6f40de7268b81e0df46
-  data.tar.gz: e6da83b7427b144a8e166c7f9fe06c1bd1d8d208842e88ebc619aaba5984fca8743b6d23c27edcd6474d949e0e34402f36ee5ed4b26a99a3689f0d6314bfae61
+  metadata.gz: 940704eada9b65c4fa5b3b7c6f05f658c98d208630ffa541d7000a9d76fb0d8a8771a3125b392721fe1e829836c59feef13611d831afbd49b5315521d1b18ff3
+  data.tar.gz: cb05f2bf0fbd31facc83019ca9d075317fd197b67b9c4668169a817543fdb68cff5dff44ad23db59f41eeedc4e299cd471a5080894c08c32ef9d5699f6f6e88d

data/app/controllers/stenographer/admin/links_controller.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_dependency 'stenographer/application_controller'
+
+module Stenographer
+  class Admin::LinksController < ApplicationController
+    before_action :assign_link, only: %i[show edit update destroy]
+
+    def new
+      @link = Link.new
+    end
+
+    def create
+      @link = Link.new(link_params)
+
+      if @link.save
+        redirect_to admin_link_path(@link), notice: 'Link Created'
+      else
+        flash.now[:alert] = @link.errors.full_messages.to_sentence
+        render :new
+      end
+    end
+
+    def index
+      page = params[:page] || 1
+      @links = Link.order(created_at: :desc).paginate(page: page, per_page: Stenographer.per_page)
+    end
+
+    def show; end
+
+    def edit; end
+
+    def update
+      message = {}
+
+      if @link.update(link_params)
+        message[:notice] = 'Link Updated'
+
+        redirect_to admin_link_path(@link), message
+      else
+        flash.now[:alert] = @link.errors.full_messages.to_sentence
+        render :edit
+      end
+    end
+
+    def destroy
+      if @link.destroy
+        redirect_to admin_links_path, notice: 'Link Destroyed'
+      else
+        redirect_to admin_link_path(@link), alert: @link.errors.full_messages.to_sentence
+      end
+    end
+
+    private
+
+    def link_params
+      params.require(:link).permit(:url, :description)
+    end
+
+    def assign_link
+      @link = Link.find(params[:id])
+    end
+  end
+end

data/app/controllers/stenographer/admin_controller.rb

@@ -8,6 +8,7 @@ module Stenographer
       @change_count = Change.count
       @authentication_count = Authentication.count
       @output_count = Output.count
+      @link_count = Link.count
     end
   end
 end

data/app/models/stenographer/change.rb

@@ -18,8 +18,6 @@ module Stenographer
         end
         environments_array.uniq!
         environments_array.join(', ')
-      else
-        nil
       end
     end
 

data/app/models/stenographer/link.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Stenographer
+  class Link < ApplicationRecord
+    validates :url, presence: true
+  end
+end

data/app/views/stenographer/admin/index.html.erb

@@ -22,6 +22,13 @@
           <%= link_to 'Manage Outputs', admin_outputs_path, class: 'button' %>
         </div>
       </div>
+      <div class="tile is-parent">
+        <div class="tile is-child box notification is-warning">
+          <p class="title">Links</p>
+          <p class="subtitle"><%= pluralize(@link_count, 'Link') %></p>
+          <%= link_to 'Manage Links', admin_links_path, class: 'button' %>
+        </div>
+      </div>
     </div>
   </div>
 </section>

data/app/views/stenographer/admin/links/edit.html.erb

@@ -0,0 +1,38 @@
+<section class="section">
+  <div class="container">
+    <h1 class="title">
+      Edit Link #<%= @link.id %>
+    </h1>
+
+    <h2 class="subtitle">
+      <%= link_to 'Show', admin_link_path(@link.id) %>
+      |
+      <%= link_to 'Delete', admin_link_path(@link), :method => :delete, :data => { :confirm => 'Are you sure you want to delete this Link?' } %>
+    </h2>
+
+    <%= form_for @link, url: admin_link_path(@link), method: :patch do |f| %>
+      <div class="field">
+        <div class="control">
+          <%= f.label :url, class: 'label' %>
+          <%= f.text_field :url, class: 'input' %>
+        </div>
+      </div>
+
+      <div class="field">
+        <div class="control">
+          <%= f.label :description, class: 'label' %>
+          <%= f.text_field :description, class: 'input' %>
+        </div>
+      </div>
+
+      <div class="field is-grouped">
+        <div class="control">
+          <%= f.submit 'Update Link', class: 'button is-link' %>
+        </div>
+        <div class="control">
+          <%= link_to('Back', admin_link_path(@link.id), class: 'button is-text') %>
+        </div>
+      </div>
+    <% end %>
+  </div>
+</section>

data/app/views/stenographer/admin/links/index.html.erb

@@ -0,0 +1,38 @@
+<section class="section">
+  <div class="container">
+    <h1 class="title">
+      Link Admin
+    </h1>
+
+    <h2 class="subtitle">
+      <%= link_to 'New Link', new_admin_link_path %>
+    </h2>
+
+    <table class="table is-fullwidth is-striped">
+      <thead>
+        <tr>
+          <th>ID</th>
+          <th>URL</th>
+          <th>Description</th>
+        </tr>
+      </thead>
+      <tbody>
+      <% @links.each do |link| %>
+        <tr>
+          <td><%= link_to(link.id, admin_link_path(link.id)) %></td>
+          <td><%= link.url %></td>
+          <td>
+            <%= link_to 'View', admin_link_path(link.id), class: 'button is-small' %>
+            <%= link_to 'Edit', edit_admin_link_path(link.id), class: 'button is-small' %>
+            <%= link_to 'Delete', admin_link_path(link.id), class: 'button is-small is-danger', :method => :delete, :data => {:confirm => 'Are you sure you want to delete this Change?'} %>
+          </td>
+        </tr>
+      <% end %>
+      </tbody>
+    </table>
+
+    <div class="changes-pagination">
+      <%= will_paginate @links, renderer: BulmaPagination::Rails %>
+    </div>
+  </div>
+</section>

data/app/views/stenographer/admin/links/new.html.erb

@@ -0,0 +1,32 @@
+<section class="section">
+  <div class="container">
+    <h1 class="title">
+      Admin New Link
+    </h1>
+
+    <%= form_for @link, url: admin_links_path(@link), method: :post do |f| %>
+      <div class="field">
+        <div class="control">
+          <%= f.label :url, class: 'label' %>
+          <%= f.text_field :url, class: 'input' %>
+        </div>
+      </div>
+
+      <div class="field">
+        <div class="control">
+          <%= f.label :description, class: 'label' %>
+          <%= f.text_field :description, class: 'input' %>
+        </div>
+      </div>
+
+      <div class="field is-grouped">
+        <div class="control">
+          <%= f.submit 'Create Link', class: 'button is-link' %>
+        </div>
+        <div class="control">
+          <%= link_to('Back', admin_links_path, class: 'button is-text') %>
+        </div>
+      </div>
+    <% end %>
+  </div>
+</section>

data/app/views/stenographer/admin/links/show.html.erb

@@ -0,0 +1,32 @@
+<section class="section">
+  <div class="container">
+    <h1 class="title">
+      Link #<%= @link.id %>
+    </h1>
+
+    <h2 class="subtitle">
+      <%= link_to 'Edit', edit_admin_link_path(@link.id) %>
+      |
+      <%= link_to 'Delete', admin_link_path(@link), :method => :delete, :data => { :confirm => 'Are you sure you want to delete this Link?' } %>
+    </h2>
+
+    <div class="field">
+      <label class="label">Date</label>
+      <div><%= @link.created_at.strftime('%m/%d/%Y') %></div>
+    </div>
+
+    <div class="field">
+      <label class="label">URL</label>
+      <div><%= @link.url %></div>
+    </div>
+
+    <div class="field">
+      <label class="label">Description</label>
+      <div><%= @link.description %></div>
+    </div>
+
+    <div class="field">
+      <%= link_to('Back', admin_links_path, class: 'button is-link') %>
+    </div>
+  </div>
+</section>

data/app/views/stenographer/changes/index.html.erb

@@ -1,6 +1,18 @@
 <section class="section">
   <div class="container">
-    <h1 class="title"><%= Stenographer.app_name %></h1>
+    <nav class="panel">
+      <p class="panel-heading"><%= Stenographer.link_section_name %></p>
+
+      <div class="columns is-gapless is-multiline is-mobile">
+        <% Stenographer::Link.all.each do |link| %>
+          <div class="column is-one-third">
+            <span class="panel-block">
+              <%= link_to(link.description, link.url) %>
+            </span>
+          </div>
+        <% end %>
+      </div>
+    </nav>
 
     <% if @change_count.positive? %>
       <% date_groups = @changes.group_by_week { |change| change.created_at } %>
@@ -8,9 +20,10 @@
       <% date_groups.sort { |group1, group2| group2[0] <=> group1[0] }.each do |date_group| %>
         <article>
           <% date_group_date = date_group[0] %>
+          <% readable_group_date = date_group_date.strftime('%B %e, %Y') %>
           <% date_group_results = date_group[1] %>
 
-          <p class="title is-4 has-text-centered">Week of <%= date_group_date %></p>
+          <p class="title is-4 has-text-centered">Week of <%= readable_group_date %></p>
           <div>
             <% change_type_groups = date_group_results.group_by(&:change_type) %>
 

data/config/routes.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 Stenographer::Engine.routes.draw do
+  resources :links
   resources :changes, only: %i[index show], constraints: Stenographer::RoutingConstraints::ViewerOnly.new
   resources :changes, only: %i[create] # Created separately because we don't want it behind the routing constraints
 
@@ -12,6 +13,7 @@ Stenographer::Engine.routes.draw do
     resources :authentications, only: %i[index show destroy], constraints: Stenographer::RoutingConstraints::ManagerOnly.new
     resources :changes, constraints: Stenographer::RoutingConstraints::ManagerOnly.new
     resources :outputs, constraints: Stenographer::RoutingConstraints::ManagerOnly.new
+    resources :links, constraints: Stenographer::RoutingConstraints::ManagerOnly.new
   end
 
   get '/auth/:provider', to: 'authentications#create', as: :authentication # Used so we can access authentication_path('provider')

data/db/migrate/20181204190243_create_stenographer_links.rb

@@ -0,0 +1,10 @@
+class CreateStenographerLinks < ActiveRecord::Migration[5.2]
+  def change
+    create_table :stenographer_links do |t|
+      t.string :url
+      t.string :description
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/stenographer/templates/config/initializers/stenographer.rb

@@ -53,6 +53,12 @@ Stenographer.configure do |config|
   # config.parser = 'Stenographer::Inputs::GithubInput'
   config.parser = 'Stenographer::Inputs::GithubInput'
 
+  # Display name for the links section on the index
+  #
+  # Example:
+  # config.link_section_name = 'Useful Links'
+  config.link_section_name = 'Useful Links'
+
   # ====================================================================================================================
   #
   # GitHub Parser Configuration

data/lib/stenographer-rails.rb

@@ -31,6 +31,7 @@ module Stenographer
     mattr_accessor :parser
     mattr_accessor :tracked_branches
     mattr_accessor :branch_mapping
+    mattr_accessor :link_section_name
 
     self.app_name = 'Stenographer'
     self.app_icon = nil
@@ -49,6 +50,7 @@ module Stenographer
     self.parser = 'Stenographer::Inputs::GithubInput'
     self.tracked_branches = %w[master work]
     self.branch_mapping = { master: 'production', work: 'staging' }
+    self.link_section_name = 'Useful Links'
   end
 
   def self.configure(&block)

data/lib/stenographer/outputs/base_output.rb

@@ -5,6 +5,7 @@ module Stenographer
     class BaseOutput
       def initialize(change: nil, output: nil)
         raise StandardError, 'you must pass the Output' if output.blank?
+
         @change = change
         @output = output
       end

data/lib/stenographer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stenographer
-  VERSION = '0.6.5'
+  VERSION = '0.7.0'
 end

data/spec/controllers/stenographer/admin/authentications_controller_spec.rb

@@ -12,7 +12,7 @@ describe Stenographer::Admin::AuthenticationsController, type: :controller do
     end
 
     describe 'individual behaviors' do
-      before :each do
+      before do
         index_action
       end
 
@@ -44,7 +44,7 @@ describe Stenographer::Admin::AuthenticationsController, type: :controller do
     end
 
     describe 'individual behaviors' do
-      before :each do
+      before do
         show_action
       end
 

data/spec/controllers/stenographer/admin/changes_controller_spec.rb

@@ -13,7 +13,7 @@ describe Stenographer::Admin::ChangesController, type: :controller do
     end
 
     describe 'individual behaviors' do
-      before :each do
+      before do
         new_action
       end
 
@@ -75,7 +75,7 @@ describe Stenographer::Admin::ChangesController, type: :controller do
     end
 
     describe 'individual behaviors' do
-      before :each do
+      before do
         index_action
       end
 
@@ -104,7 +104,7 @@ describe Stenographer::Admin::ChangesController, type: :controller do
     end
 
     describe 'individual behaviors' do
-      before :each do
+      before do
         show_action
       end
 
@@ -124,7 +124,7 @@ describe Stenographer::Admin::ChangesController, type: :controller do
     end
 
     describe 'individual behaviors' do
-      before :each do
+      before do
         edit_action
       end
 
@@ -144,7 +144,7 @@ describe Stenographer::Admin::ChangesController, type: :controller do
     end
 
     describe 'individual behaviors' do
-      before :each do
+      before do
         update_action
       end
 

data/spec/controllers/stenographer/admin/links_controller_spec.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+describe Stenographer::Admin::LinksController, type: :controller do
+  routes { Stenographer::Engine.routes }
+
+  let!(:first_link) { create(:link, created_at: 2.weeks.ago) }
+  let!(:newer_link) { create(:link, created_at: 1.week.ago) }
+
+  describe '#new' do
+    def new_action(opts = {})
+      get :new, params: { }.merge(opts)
+    end
+
+    describe 'individual behaviors' do
+      before do
+        new_action
+      end
+
+      it 'assigns @link' do
+        expect(assigns(:link)).not_to be_nil
+      end
+
+      it 'renders the new page' do
+        expect(response).to render_template(:new)
+      end
+    end
+  end
+
+  describe '#create' do
+    def create_action(opts = {})
+      post :create, params: { link: { url: 'https://catchandrelease.com', description: 'Clearances and Licensing' } }.merge(opts)
+    end
+
+    describe 'individual behaviors' do
+      describe 'success' do
+        it 'creates the record' do
+          expect do
+            create_action
+          end.to change(Stenographer::Link, :count).by(1)
+        end
+
+        it 'redirects to the admin path' do
+          create_action
+
+          expect(response).to redirect_to(admin_link_path(Stenographer::Link.last))
+        end
+      end
+
+      describe 'failure' do
+        it 'does not create the record' do
+          expect do
+            create_action(link: { url: nil })
+          end.not_to change(Stenographer::Link, :count)
+        end
+
+        it 'redirects to the admin path' do
+          create_action(link: { url: nil })
+
+          expect(response).to render_template(:new)
+        end
+      end
+    end
+  end
+
+  describe '#index' do
+    def index_action(opts = {})
+      get :index, params: {}.merge(opts)
+    end
+
+    describe 'individual behaviors' do
+      before do
+        index_action
+      end
+
+      describe 'links' do
+        it 'assigns @links' do
+          expect(assigns(:links)).not_to be_nil
+        end
+
+        it 'includes all links' do
+          expect(assigns(:links)).to include(first_link)
+          expect(assigns(:links)).to include(newer_link)
+        end
+      end
+
+      describe 'order' do
+        it 'created at desc' do
+          expect(assigns(:links)).to match_array([newer_link, first_link])
+        end
+      end
+    end
+  end
+
+  describe '#show' do
+    def show_action(opts = {})
+      get :show, params: { id: first_link.id }.merge(opts)
+    end
+
+    describe 'individual behaviors' do
+      before do
+        show_action
+      end
+
+      it 'assigns @change' do
+        expect(assigns(:link)).to eq(first_link)
+      end
+
+      it 'renders the show page' do
+        expect(response).to render_template(:show)
+      end
+    end
+  end
+
+  describe '#edit' do
+    def edit_action(opts = {})
+      get :edit, params: { id: first_link.id }.merge(opts)
+    end
+
+    describe 'individual behaviors' do
+      before do
+        edit_action
+      end
+
+      it 'assigns @link' do
+        expect(assigns(:link)).to eq(first_link)
+      end
+
+      it 'renders the edit page' do
+        expect(response).to render_template(:edit)
+      end
+    end
+  end
+
+  describe '#update' do
+    def update_action(opts = {})
+      patch :update, params: { id: first_link.id, link: { description: 'GitHub' } }.merge(opts)
+    end
+
+    describe 'individual behaviors' do
+      before do
+        update_action
+      end
+
+      it 'updates the record' do
+        expect(first_link.reload.description).to eq('GitHub')
+      end
+
+      it 'redirects to the admin change path' do
+        expect(response).to redirect_to(admin_link_path(first_link))
+      end
+    end
+  end
+
+  describe '#destroy' do
+    def destroy_action(opts = {})
+      delete :destroy, params: { id: first_link.id }.merge(opts)
+    end
+
+    describe 'individual behaviors' do
+      it 'destroys the record' do
+        expect do
+          destroy_action
+        end.to change(Stenographer::Link, :count).by(-1)
+      end
+
+      it 'redirects to the admin path' do
+        destroy_action
+
+        expect(response).to redirect_to(admin_links_path)
+      end
+    end
+  end
+end