seamess 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 174418a66944d3e44dfc49ddb71b64209a657967
+  data.tar.gz: 76f18b85d38b29b5805d45ee7fccc49bdde4538b
+SHA512:
+  metadata.gz: 5d2fb41b5ba975c69927313b7929b5e5236ea313c82e873b5c00bfe15a2e9643f06516e3c9794a464132fc880366e687d0872d9b8be8b25865fbdbae942597ad
+  data.tar.gz: 96e03522cc4dc56b307123338147fe3f78c7aad9731a35ace1e039cac6ce3f6570cc9b0f74b0a9b2746f0420ee7590613bbae066d4fa02dd0223a440b90a0a60

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Ridgeway Digital Inc.
+
+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,166 @@
+# Seamess
+
+Seamess is an extremely opinionated CMS framework.
+
+(To be more clear, *I* am opinionated. It is just an inert pile of code. But the effect is the same.)
+
+Seamess is a Rails 5.1-based engine that can be used with any other Rack app.
+
+It also uses:
+
+- Bootstrap 4 beta
+- jQuery 3
+- haml
+- sass (indented style, not bracket style)
+
+And when I say it's opinionated, I mean that I won't entertain requests to change any of the above.
+
+It's also opinionated because it believes and enforces the following:
+
+1. Page structure should be flat, but slugs should be wholly in the hands of the user. So if you want to nest a page, go ahead and create `my-page/` and `my-page/sub-page/`.
+2. Posts and pages should be written in Markdown. Fancy editors break stuff. Learn Markdown, you scrub.
+3. Few moving parts. No generators. Those things are murder to maintain.
+4. Max depth of two namespaces, and preferrably only one.
+5. Maybe more. I'm not 100% solid on the other stuff yet.
+
+## Usage
+
+### Installation
+
+Install the gem into your Rack application by adding to `Gemfile`:
+
+```ruby
+gem 'seamess'
+```
+
+Don't forget to `bundle`.
+
+Mount the engine in your `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  mount Seamess::Engine, at: "/my-path"
+  root to: "some_controller#some_action"
+end
+```
+
+If you're going to serve the application at the root of your site, change that
+to this:
+
+```ruby
+Rails.application.routes.draw do
+  mount Seamess::Engine, at: "/"
+  root to: Seamess::Engine
+end
+```
+
+### Migrations / Seeds
+
+Add to `db/seeds.rb`:
+
+```ruby
+Seamess::Engine.load_seed
+```
+
+Then run `rake seamess:install:migrations db:migrate db:seed`.
+
+### Assets
+
+Seamess defines base stylesheets but expects that you will override them. So you have to actually create your own, and use sass imports to bring the Seamess sheets into your site. This gives you the bonus of being able to override any variables we define.
+
+Create the `app/assets/stylesheets/partials` directory and create `app/assets/stylesheets/partials/variables.sass` within it.
+
+Create `app/assets/stylesheets/application.(scss|sass)` and add to it:
+
+```sass
+@import "partials/variables"
+@import "seamess/seamess"
+```
+
+Create `app/assets/stylesheets/manager.(scss|sass)` and add to it:
+
+```sass
+@import "partials/variables"
+@import "seamess/manager"
+```
+
+### Layouts
+
+Create `app/views/layouts/application.html.haml` and add the following content:
+
+```haml
+= extends :'layouts/seamess/application'
+```
+
+Seamess also ships with a few layouts:
+
+`seamess/application`
+: The base template. Gives you the basics. You should probably not use this layout, but extend it on your own.
+
+`seamess/columnar`
+: A basic template that can be used for a 12-column reduced-width grid layout. You'd use this on most pages, unless you want a full-width layout. Note that this layout extends from `application`, not `seamess/application`.
+
+`seamess/fluid`
+: Another basic template that uses Bootstrap's `.container-fluid` styling for a full-width responsive display. This also extends from `application`, not `seamess/application`.
+
+`seamess/pages`
+: A template which extends `seamess/columnar`. I use it to display full-width pages, which look a little bulky when they are the full 12 columns. So this template provides a simple wrapper to further shrink down columnar content.
+
+`seamess/manager`
+: A template which is used for the manager. This extends from `seamess/fluid`. In general, you probably don't want to mess around with this one.
+
+Seamess makes great use out of the `nestive` gem for parent/child layouts, and for denoting overridable content chunks. **If you override a template that has a slash in it, you must prepend `layout/`, or the layout won't be found.**
+
+Nestive does let us do some pretty amazing things. For example, the default brand in Seamess is just controlled by `ENV['SITE_TITLE']`. But say we want to replace that with something interesting. The layout inheritance lets us do something like the following:
+
+```haml
+-# app/views/layouts/application.html.haml
+= extends :'layouts/seamess/application' do
+  = replace :nav_brand do
+    = link_to seamess.root_url, class: "navbar-brand" do
+      %span.something-funky MyBrand
+
+  -# You need to have 'yield' here or else body content will be missing.
+  = yield
+```
+
+Since all of Seamess's layouts inherit from the main app's `application` layout (excepting `application`), this will be present on all of the site's pages.
+
+## Integrating
+
+### Users
+
+You must have at very least a user class in your home application. It's
+recommended that you also have an `Admin` class. Be sure to set these in an
+initializer:
+
+```ruby
+Seamess.admin_class = "Admin"
+```
+
+Seamess also makes the assumption that the following methods will be available
+to it within both controllers and views:
+
+- `authenticate_admin!`
+- `current_admin`
+- `admin_signed_in?`
+
+And looks for the following route:
+
+- `main_app.destroy_admin_session_path [DELETE]`
+
+You should make sure these are defined in your ApplicationHelper and set as view
+helpers if they aren't already done so for you. (Coincidentally, if you're using
+Devise in your host app with an `Admin` class, this is done for you! How easy.)
+
+### Devise
+
+Be sure to set `config.router_name = :main_app` in your
+`config/initializers/devise.rb` if you choose Devise for your users.
+
+## Contributing
+
+It's still private. Just ping me.
+
+## 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,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Seamess'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+

data/app/assets/config/seamess_manifest.js

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

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

@@ -0,0 +1,13 @@
+// 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_tree .

data/app/assets/javascripts/seamess/manager.js

@@ -0,0 +1,6 @@
+//= require rails-ujs
+//= require turbolinks
+//= require jquery3
+//= require popper
+//= require bootstrap-sprockets
+//= require_self

data/app/assets/stylesheets/seamess/manager.sass

@@ -0,0 +1,2 @@
+@import "seamess/partials/shared"
+@import "seamess/partials/manager"

data/app/assets/stylesheets/seamess/partials/footer.sass

@@ -0,0 +1,7 @@
+footer
+  @extend .py-4
+  @extend .px-1
+  @extend .mt-5
+  @extend .text-center
+  @extend .text-muted
+  background-color: $footer-background-color

data/app/assets/stylesheets/seamess/partials/layouts.sass

@@ -0,0 +1,19 @@
+main
+  body.columnar &
+    @extend .container
+    @extend .mt-5
+
+    h1
+      @extend .mb-4
+
+  body.fluid &
+    @extend .container-fluid
+
+  body.pages &
+    .content
+      @extend .row
+      @extend .justify-content-center
+
+    .text
+      @extend .col-12
+      @extend .col-md-8

data/app/assets/stylesheets/seamess/partials/manager.sass

@@ -0,0 +1,48 @@
+.sidebar-container
+  @extend .row
+
+  nav
+    @extend .col-sm-3
+    @extend .col-md-2
+    @extend .d-none
+    @extend .d-sm-block
+    @extend .bg-light
+
+    position: fixed
+    top: $admin-navbar-height
+    bottom: 0
+    left: 0
+    z-index: 1000
+    padding: 20px 0
+    overflow-x: hidden
+    overflow-y: auto
+    border-right: 1px solid #eee
+
+    .nav
+      margin-bottom: 20px
+
+    .nav-item
+      width: 100%
+
+    .nav-item + .nav-item
+      margin-left: 0
+
+    .nav-link
+      border-radius: 0
+
+  .content
+    @extend .col-sm-9
+    @extend .ml-sm-auto
+    @extend .col-md-10
+    @extend .py-3
+
+    margin-top: $admin-navbar-height
+
+  .actions
+    @extend .text-right
+    @extend .pr-5
+
+  h1
+    @extend .mb-5
+    @extend .pb-3
+    border-bottom: 1px solid #eee

data/app/assets/stylesheets/seamess/partials/masthead.sass

@@ -0,0 +1,27 @@
+header.masthead
+  body.columnar &
+    @extend .container
+
+  nav
+    @extend .navbar
+    @extend .navbar-expand-md
+    @extend .navbar-light
+    @extend .bg-white
+
+    body.columnar &
+      @extend .row
+
+    body.admin &
+      @extend .fixed-top
+
+    body.admin &
+      @extend .navbar-dark
+      @extend .bg-dark
+
+  #navbar-contents
+    @extend .collapse
+    @extend .navbar-collapse
+
+    > ul
+      @extend .ml-auto
+

data/app/assets/stylesheets/seamess/partials/shared.sass

@@ -0,0 +1,5 @@
+@import "bootstrap"
+@import "seamess/partials/variables"
+@import "seamess/partials/layouts"
+@import "seamess/partials/masthead"
+@import "seamess/partials/footer"

data/app/assets/stylesheets/seamess/partials/variables.sass

@@ -0,0 +1,2 @@
+$footer-background-color: #222 !default
+$admin-navbar-height: 56px !default

data/app/assets/stylesheets/seamess/seamess.sass

@@ -0,0 +1 @@
+@import "seamess/partials/shared"

data/app/controllers/seamess/application_controller.rb

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

data/app/controllers/seamess/manager/base_controller.rb

@@ -0,0 +1,5 @@
+class Seamess::Manager::BaseController < Seamess::ApplicationController
+  layout "seamess/manager"
+
+  before_action :authenticate_admin!
+end

data/app/controllers/seamess/manager/dashboard_controller.rb

@@ -0,0 +1,4 @@
+class Seamess::Manager::DashboardController < Seamess::Manager::BaseController
+  def dashboard
+  end
+end

data/app/controllers/seamess/manager/pages_controller.rb

@@ -0,0 +1,52 @@
+class Seamess::Manager::PagesController < Seamess::Manager::BaseController
+
+  def index
+    @pages = Seamess::Page.for_manager_index
+  end
+
+  def show
+    @page = Seamess::Page.find(params[:id])
+  end
+
+  def new
+    @page = Seamess::Page.new
+  end
+
+  def create
+    @page = Seamess::Page.new(page_create_params)
+
+    if @page.save
+      flash[:success] = "Saved the page."
+      redirect_to seamess.manager_pages_path
+    else
+      flash[:error] = "Something went wrong:"
+      render :new
+    end
+  end
+
+  def edit
+    @page = Seamess::Page.find(params[:id])
+  end
+
+  def update
+    @page = Seamess::Page.find(params[:id])
+
+    if @page.update_attributes(page_update_params)
+      flash[:success] = "Updated the page."
+      redirect_to seamess.manager_pages_path
+    else
+      flash[:error] = "Something went wrong:"
+      render :edit
+    end
+  end
+
+  private def page_create_params
+    params.require(:page).permit(
+      :slug,
+      :title,
+      :body
+    )
+  end
+
+  alias_method :page_update_params, :page_create_params
+end