attorney 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 9bdb86641ec32c41a8a5698b8b49890316ee6f9b1a72e1a025edb0ac96ece410
-  data.tar.gz: 2056fcb8c9b5f26003f6ff748a3784a5daac57e9dc4913f0ca8899d3d52b643e
+SHA1:
+  metadata.gz: 9d7311db63d4a9db95408cad0cbb7ef07d05f73c
+  data.tar.gz: a7ccf0d951276dcf307aba2a43ef5a1c0980b5da
 SHA512:
-  metadata.gz: b4cca6db469589296740232c69750a2a1c1cf089068c2a200fcb4d19d3ffbca4dd5bc9c38fc839bd522ad6eed2d163533fcbf430277193cbda540451098e731e
-  data.tar.gz: 9a7a03e1fbd70b7009238050f6977b74182cc24d9ffd9ce6dc6460290b9b4c36b25e68df983cdc1c7308519d05041794a9e4fd54d4094042803d60b1a6106bbe
+  metadata.gz: c3ced4ffaa41132d1c5ce3eb4604ec492e180d85d404c1e9b134c3b55df39ddf025f646ca5347dc2f34ae2fc604519601756ea46fbfe8d3d81346dd75b0bb1e7
+  data.tar.gz: 2be022c74b3995ab387e37ecd74adfe73ffd2df28a6061fa83952b2c9503d90f25dbfbf9ed184200ffaa11758c0353eb2643b112f45c8d6705d3c6eb319307e8

data/Rakefile

@@ -1,6 +1,22 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+task test: :spec
 
-task :default => :spec
+require 'rails'
+if Rails.version.start_with?('5.0')
+  APP_RAKEFILE = File.expand_path('../spec/support/dummy/rails5_0/Rakefile', __FILE__)
+elsif Rails.version.start_with?('5.1')
+  APP_RAKEFILE = File.expand_path('../spec/support/dummy/rails5_1/Rakefile', __FILE__)
+end
+
+
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+require 'bundler/gem_tasks'

data/app/assets/config/attorney_manifest.js

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

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

@@ -0,0 +1,16 @@
+// 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. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require 'attorney/bootstrap.bundle.min'
+//= require_tree .

data/app/assets/javascripts/attorney/form_errors.js

@@ -0,0 +1,13 @@
+(function() {
+  var FormErrors = function() {
+    this.render = function() {
+      form().find('.field_with_errors input').addClass('is-invalid');
+    };
+
+    var form = function() {
+      return $("form[data-style-form-errors='true']");
+    };
+  };
+
+  $(document).ready(function() { new FormErrors().render() });
+})();

data/app/assets/javascripts/attorney/rich_editor.js

@@ -0,0 +1,19 @@
+(function() {
+  var RichEditor = function() {
+    this.show = function() {
+      renderEditors(findTextAreas());
+    };
+
+    var findTextAreas = function() {
+      return $("textarea[data-rich-editor='true']")
+    };
+
+    var renderEditors = function($inputFields) {
+      $inputFields.each(function(index, inputField) {
+        CKEDITOR.replace(inputField.getAttribute("id"));
+      });
+    };
+  };
+
+  $(document).ready(function() { new RichEditor().show() });
+})();

data/app/assets/stylesheets/attorney/application.css

@@ -0,0 +1,16 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require 'attorney/bootstrap.min'
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/attorney/admin/documents_controller.rb

@@ -0,0 +1,49 @@
+require_dependency "attorney/application_controller"
+
+module Attorney
+  class Admin::DocumentsController < ApplicationController
+    http_basic_authenticate_with name: Attorney.http_auth[:name], password: Attorney.http_auth[:password]
+    before_action :set_document, only: [:show, :edit, :update, :destroy]
+
+    def index
+      @documents = Document.all
+    end
+
+    def new
+      @document = Document.new
+    end
+
+    def create
+      @document = Document.new(document_params)
+
+      if @document.save
+        redirect_to admin_document_url(@document), notice: 'Document was successfully created.'
+      else
+        render :new
+      end
+    end
+
+    def update
+      if @document.update(document_params)
+        redirect_to admin_document_url(@document), notice: 'Document was successfully updated.'
+      else
+        render :edit
+      end
+    end
+
+    def destroy
+      @document.destroy
+      redirect_to admin_documents_url, notice: 'Document was successfully destroyed.'
+    end
+
+    private
+
+    def set_document
+      @document = Document.find(params[:id])
+    end
+
+    def document_params
+      params.require(:document).permit(:slug, :published, :content)
+    end
+  end
+end

data/app/controllers/attorney/application_controller.rb

@@ -0,0 +1,5 @@
+module Attorney
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/attorney/documents_controller.rb

@@ -0,0 +1,11 @@
+require_dependency 'attorney/application_controller'
+
+module Attorney
+  class DocumentsController < ApplicationController
+    layout Attorney.application_layout
+
+    def show
+      @document = Document.published.find_by_slug!(params[:slug])
+    end
+  end
+end

data/app/helpers/attorney/application_helper.rb

@@ -0,0 +1,13 @@
+module Attorney
+  module ApplicationHelper
+    def attorney_mounted_path
+      Rails.application.routes.named_routes[:attorney].format(nil)
+    end
+
+    def show_notice(notice)
+      if notice.present?
+        content_tag :p, notice, id: 'notice', class: 'alert alert-primary', role: 'alert'
+      end
+    end
+  end
+end

data/app/helpers/attorney/documents_helper.rb

@@ -0,0 +1,11 @@
+module Attorney
+  module DocumentsHelper
+    def published_badge(document)
+      if document.published?
+        content_tag :span, 'Published', class: 'badge badge-success'
+      else
+        content_tag :span, 'Not published', class: 'badge badge-secondary'
+      end
+    end
+  end
+end

data/app/jobs/attorney/application_job.rb

@@ -0,0 +1,4 @@
+module Attorney
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/attorney/application_mailer.rb

@@ -0,0 +1,6 @@
+module Attorney
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/attorney/application_record.rb

@@ -0,0 +1,5 @@
+module Attorney
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/attorney/document.rb

@@ -0,0 +1,19 @@
+module Attorney
+  class Document < ApplicationRecord
+    scope :published, -> { where(published: true) }
+
+    validates :slug, uniqueness: true
+    validates :slug, presence: true
+    validate :slug_format_is_valid
+
+    private
+
+    def slug_format_is_valid
+      return if slug.nil?
+
+      unless slug.parameterize == slug
+        errors.add(:slug, "Slug format is invalid, try \"#{slug.parameterize}\" instead.")
+      end
+    end
+  end
+end

data/app/views/attorney/admin/documents/_form.html.erb

@@ -0,0 +1,49 @@
+<%= form_for([:admin, document], data: { style_form_errors: true }) do |form| %>
+  <% if document.errors.any? %>
+    <div class="alert alert-danger" role="alert">
+      <h4><%= pluralize(document.errors.count, 'error') %> prohibited this document from being saved:</h4>
+
+      <ul>
+      <% document.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="form-group row">
+    <div class="col-2 ">
+    <%= form.label :slug, class: 'col-form-label' %>
+    </div>
+    <div class="col-10">
+      <%= form.text_field :slug, class: 'form-control', placeholder: 'terms-and-conditions' %>
+      <small class="form-text text-muted"><%= "Slugs are used to create your documents url. For example: https://www.website.com#{attorney_mounted_path}/terms-and-conditions" %></small>
+    </div>
+  </div>
+
+  <br>
+  <div class="form-group row">
+    <div class="col-2 ">
+      <%= form.label :published, 'Publish', class: 'col-form-label' %>
+    </div>
+    <div class="col-10">
+      <%= form.check_box :published %>
+      <small class="form-text text-muted"><%= "The document won't be visible until you publish it" %></small>
+    </div>
+  </div>
+
+  <br>
+  <div class="form-group row">
+    <%= form.label :content, class: 'col-2 col-form-label' %>
+    <div class="col-10">
+      <%= form.text_area :content, class: 'form-control', data: { 'rich-editor' => true } %>
+    </div>
+  </div>
+
+  <div class="actions">
+    <%= form.submit class: 'btn btn-primary' %>
+    <%= link_to 'Cancel', admin_documents_path, class: 'btn btn-secondary' %>
+  </div>
+<% end %>
+
+<%= javascript_include_tag 'https://cdn.ckeditor.com/4.8.0/standard/ckeditor.js' %>

data/app/views/attorney/admin/documents/edit.html.erb

@@ -0,0 +1,3 @@
+<h1>Editing Document</h1>
+<br>
+<%= render 'form', document: @document %>

data/app/views/attorney/admin/documents/index.html.erb

@@ -0,0 +1,37 @@
+<h1>Documents list</h1>
+<br>
+<% if @documents.any? %>
+  <table class="table table-striped">
+    <thead>
+    <tr>
+      <th scope="col" width="20%">Slug</th>
+      <th scope="col">Published?</th>
+      <th scope="col">Content</th>
+      <th scope="col" width="10%" class="text-center" colspan="2"></th>
+    </tr>
+    </thead>
+
+    <tbody>
+    <% @documents.each do |document| %>
+      <tr>
+        <td scope="row"><%= link_to document.slug, admin_document_path(document), class: 'text-secondary' %></td>
+        <td><%= published_badge(document) %></td>
+        <td><%= document.content.truncate(200) %></td>
+        <td><%= link_to 'Edit', edit_admin_document_path(document), class: 'text-primary' %></td>
+        <td><%= link_to 'Destroy', admin_document_path(document), class: 'text-danger', method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <% end %>
+    </tbody>
+  </table>
+
+  <br>
+  <%= link_to 'New Document', new_admin_document_path, class: 'btn btn-primary' %>
+<% else %>
+  <div class="card text-center">
+    <div class="card-body">
+      <h5 class="card-title">We don't have anything to show yet :(</h5>
+      <p class="card-text">Looks like you haven't created any documents. Try creating the first one by clicking the button below!</p>
+      <%= link_to 'New Document', new_admin_document_path, class: 'btn btn-primary' %>
+    </div>
+  </div>
+<% end %>

data/app/views/attorney/admin/documents/new.html.erb

@@ -0,0 +1,3 @@
+<h1>New Document</h1>
+<br>
+<%= render 'form', document: @document %>

data/app/views/attorney/admin/documents/show.html.erb

@@ -0,0 +1,13 @@
+<h1><%= "#{attorney_mounted_path}/#{@document.slug}" %></h1>
+<br>
+<h3><%= published_badge(@document) %></h3>
+<br>
+
+<div class="card">
+  <div class="card-body">
+    <%= @document.content.html_safe %>
+  </div>
+</div>
+
+<br>
+<%= link_to 'Back', admin_documents_path, class: 'text-secondary' %>

data/app/views/attorney/documents/show.html.erb

@@ -0,0 +1 @@
+<%= @document.content.html_safe %>

data/app/views/layouts/attorney/application.html.erb

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Attorney</title>
+
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <%= stylesheet_link_tag    'attorney/application', media: 'all' %>
+    <%= javascript_include_tag 'attorney/application' %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <nav class="navbar navbar-dark bg-dark">
+      <div class="container">
+        <%= link_to 'Documents Admin', admin_documents_path, class: 'navbar-brand' %>
+      </div>
+    </nav>
+
+    <div class="container">
+      <br>
+      <%= show_notice(notice) %>
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,9 @@
+Attorney::Engine.routes.draw do
+  root to: 'admin/documents#index'
+
+  namespace :admin do
+    resources :documents
+  end
+
+  get '/:slug', to: 'documents#show', as: :document
+end

data/db/migrate/20180205173208_create_attorney_documents.rb

@@ -0,0 +1,13 @@
+class CreateAttorneyDocuments < ActiveRecord::Migration[5.0]
+  def change
+    create_table :attorney_documents do |t|
+      t.string :slug, null: false
+      t.boolean :published, null: false, default: false
+      t.text :content
+
+      t.timestamps
+    end
+
+    add_index :attorney_documents, :slug, unique: true
+  end
+end

data/lib/attorney.rb

@@ -1,5 +1,15 @@
-require "attorney/version"
+require 'attorney/engine'
+require 'jquery-rails'
 
 module Attorney
-  # Your code goes here...
+  mattr_accessor :application_layout do
+    'application'
+  end
+
+  def self.http_auth
+    {
+      name:     ENV['ATTORNEY_HTTP_AUTH_NAME'] || 'attorney',
+      password: ENV['ATTORNEY_HTTP_AUTH_PASSWORD'] || 'secret'
+    }
+  end
 end

data/lib/attorney/engine.rb

@@ -0,0 +1,14 @@
+module Attorney
+  class Engine < ::Rails::Engine
+    isolate_namespace Attorney
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'attorney.assets.precompile' do |app|
+      app.config.assets.paths << Rails.root.join('vendor', 'assets', 'javascripts')
+      app.config.assets.paths << Rails.root.join('vendor', 'assets', 'stylesheets')
+    end
+  end
+end