ceo 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7d0eafb5b45b069e461c57ab1d482e84903acd5
-  data.tar.gz: d8203063d09cd6586bc4b11f477fe0a01f7bfc5c
+  metadata.gz: 29ef98d7acc36e9f5c44d8a948aacc544b8484c9
+  data.tar.gz: 4c1abd5de52b6294154f06ab7781187597121801
 SHA512:
-  metadata.gz: 1de568923cd8d93c296475b35115f86c7dbab8d1d1e4baa62b284b7b6cccdcf5d003118ae3c0b90ce08e2f293582e1ff23631b7d03cdf8d307a27256258ec8b2
-  data.tar.gz: d3c7ebada366aae35be9f017cfcd7ca9e1d8e48be21c2cc47be3f4c1c2d34db74b5547bd856e16f1b0a61723c395b7d98e783780ebf719adcb9594c95e8ffa63
+  metadata.gz: eef6f2c3cfe05bf239246d4ac58ddd1bce7a56ba93576fecf3bbc2b2582b2de5ef50acb37420f7b551f48077d2383b3cb65cf0649d7b4db57f4064425332de4c
+  data.tar.gz: 65f2d4be87b23b1c3e543f424ae7c919bb88a3ca07e432d24765d82941962cfe86d479ce0c0ace09d3403b59d2291be1e9928c543929bfef2b204298169663c3

data/README.md

@@ -9,3 +9,138 @@ CEO
 [![Build Status](https://travis-ci.org/littlelines/ceo.svg?branch=master)](https://travis-ci.org/littlelines/ceo)
 [![Code Climate](https://codeclimate.com/github/littlelines/ceo/badges/gpa.svg)](https://codeclimate.com/github/littlelines/ceo)
 [![Inline docs](http://inch-ci.org/github/littlelines/ceo.svg?branch=master)](http://inch-ci.org/github/littlelines/ceo)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ceo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ceo
+
+## Usage
+
+For basic CRUD that just works:
+
+    $ bundle exec rails generate admin apples
+
+This will create:
+  + *app/controllers/admin/apples_controller.rb*
+  + *app/views/admin/apples/_form.html.erb*
+
+And route: `admin_for :apples`
+
+Creating all apple resource routes namespaced under admin.
+
+### Authentication
+
+Every generated controller will call `#authenticate_admin!` before every action.
+This does nothing if `#authenticate_admin!` is not defined in your application.
+You must write your own `#authenticate_admin!` method in your `ApplicationController`.
+
+### Getting started
+
+Start up your server and visit [http://localhost:3000/admin/apples](). Customize
+the apples form in *app/views/admin/apples/_form.html.erb*, where:
+
+    <%= # "f" is exposed as a form object %>
+
+[SimpleForm](https://github.com/plataformatec/simple_form) can be used here to
+maintain style consistency with the rest of the provided admin panel.
+
+Once this form is fleshed out, you will be able to create, read, update, and
+destroy apples at will.
+
+### Customization
+
+To customize what attributes appear at */admin/apples* and/or
+*/admin/apples/:id*, you can pass a hash using the keys `:only` (show
+__*only*__ these attributes), `:except` (show everything __*except*__ these
+attributes), and/or `:query` (show attributes of associated objects).
+
+#### Example
+
+`apple_instance` responds to `name` and `product_id` where `Apple`
+`has_many :seeds` and `Seed` responds to count.
+
+*app/controllers/admin/apples_controller.rb*
+
+```ruby
+module Admin
+  class ApplesController < CEOController
+    # Only shows ID, Name, and Seed Count in admin#index table.
+    def index
+      super(
+        only: [:id, :name],
+        query: ['seeds.count']
+      )
+    end
+
+    def show
+      super(
+        # Displays all of apple's attributes as well as its seeds.count in
+        # admin#show.
+        query: ['seeds.count']
+      )
+    end
+  end
+end
+```
+
+### Further Customization
+
+Need something more customizable/complex than basic CRUD functionality? Instead
+of working around a black box, simply inherit from `AdminController` instead of
+`CEOController` for a clean slate:
+
+```ruby
+module Admin
+  class ApplesController < AdminController
+    # Plain old Rails controller
+  end
+end
+```
+
+### _Even Further_ Customization
+
+If none of these options is right for you, you can override or add to
+`AdminController` by simply creating a `AdminMiddleware` module in
+your Rails application path (we suggest services or initializers, but
+it's up to you).
+
+### Styling
+
+For consistency in styling, you can find the CEO styleguide at
+[http://localhost:3000/admin/styleguide]() after installing CEO in your
+application.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+dependencies. Then, run `rake test` to run the tests. You can also run
+`bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake
+install`.
+
+## TODO
+* [ ] Allow option to generate views in HAML
+* [ ] Make adding content/customizing dashboard easier
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/littlelines/ceo.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/app/assets/stylesheets/admin/application.sass

@@ -0,0 +1,59 @@
+//= require_self
+// require jquery-ui/datepicker
+// require jquery-ui/sortable
+
+@import settings/global
+@import settings/media-queries
+@import settings/colors
+@import settings/backgrounds
+@import settings/borders
+@import settings/type
+@import settings/forms
+@import settings/tables
+@import settings/header
+
+@import tools/button-generator
+@import tools/clearfix
+@import tools/dynamic-text-lightness
+@import tools/ellipsize
+@import tools/greyscale
+@import tools/link-generator
+@import tools/notifier-generator
+@import tools/panel-generator
+@import tools/placeholder
+@import tools/space-generator
+
+@import generic/reset
+
+@import base/forms
+@import base/layout
+@import base/lists
+@import base/lists
+@import base/scale
+@import base/svg
+@import base/tables
+@import base/type
+
+@import objects/avatar
+@import objects/cart
+@import objects/layout
+@import objects/lists
+@import objects/logo
+@import objects/nav
+@import objects/panels
+// @import @objects/search
+@import objects/tables
+@import objects/titles
+
+@import components/content
+@import components/filters
+@import components/forms
+@import components/header
+@import components/links
+@import components/nav
+@import components/notifier
+@import components/sidebar
+@import components/user
+
+@import overrides/forms
+@import overrides/jquery-ui

data/app/assets/stylesheets/admin/base/forms.sass

@@ -0,0 +1,138 @@
+////////////////////
+// Input/Range Placeholders
+////////////////////
+
+%input-text-styles
+  appearance: none
+  background-color: $color-secondary
+  border: none
+    radius: 0
+  box-shadow: none
+  cursor: text
+  display: inline-block
+  font:
+    family: $font-family
+    size: inherit
+  line-height: $line-height
+  padding: $input-padding
+  vertical-align: middle
+  width: 100%
+  @media #{$large-up}
+    width: 50%
+  &:active, &:focus, &:hover
+    background-color: lighten($color-secondary, 1.5%)
+  +placeholder
+    color: rgba($font-color, .5)
+    +ellipsize
+
+%input-range-track-styles
+  @extend %input-text-styles
+
+%input-range-thumb-styles
+  appearance: none
+  background: $color-function
+  height: 1rem
+  width: 1rem
+
+////////////////////
+// Inputs
+////////////////////
+
+.input
+  @extend %input-text-styles
+  + .label
+    margin: 0 1em 0 .25em
+
+  // .input--hidden
+  &--hidden
+    display: none
+
+  // .input--range
+  &--range
+    appearance: none
+    vertical-align: middle
+    //&::-webkit-slider-runnable-track
+      @extend %input-range-track-styles
+    //&::-webkit-slider-thumb
+      @extend %input-range-thumb-styles
+    // TODO ADD CROSS BROWSER SUPPORT, FIGURE OUT WAY TO MAKE RENDER LAST FOR FIREFOX SUPPORT
+
+  // .input--search
+  &--search
+    outline-offset: -2px
+    &::-webkit-search-decoration, &::-webkit-search-cancel-button, &::-webkit-search-results-button, &::-webkit-search-results-decoration
+      display: none
+
+  // .input:disabled, .input--disabled
+  &:disabled, &--disabled
+    cursor: default
+    opacity: .5
+    &:hover
+      background-color: $color-secondary
+    + label
+      cursor: default
+
+  // .input--error, .input--alert
+  &--error, &--alert
+    box-shadow: inset 0 0 0 $border-width $color-alert
+
+  // .input--success
+  &--success
+    box-shadow: inset 0 0 0 $border-width $color-success
+
+.boolean, .radio
+  @extend %input-text-styles
+  cursor: pointer
+  width: auto
+  &:before
+    content: ''
+    display: block
+    height: 1.1em
+    line-height: 1.3
+    width: 1.1em
+  &:checked:before
+    content: asset-url('check.svg')
+
+.boolean
+  border-radius: $border-radius
+
+.radio, .radio:before
+  border-radius: $border-radius-round
+
+.label
+  cursor: pointer
+  display: inline-block
+  line-height: $line-height
+  padding: $input-padding 0
+  vertical-align: middle
+  width: 50%
+  @media #{$large-up}
+    width: 25%
+    + .input, + .select, + .textarea, + .boolean, + .radio
+      margin: 0 1em 0 .25em
+
+.select
+  @extend %input-text-styles
+  +ellipsize
+  $svg-color: rgba($font-color, 0.99)
+  background:
+    image: url('data:image/svg+xml;utf8,<svg class="svg chevron-down" xmlns="http://www.w3.org/2000/svg" viewBox="-2275.4 3060.9 12.3 6.9" enable-background="new -2275.4 3060.9 12.3 6.9"><path fill="#{$svg-color}" d="M-2263.9 3060.9l-5.3 5.5-5.4-5.5-.8.8 6.2 6.1 6.1-6.1-.8-.8z"/></svg>')
+    position: right .5em center
+    size: 1em
+    repeat: no-repeat
+  cursor: pointer
+  padding-right: 2em
+
+.textarea
+  @extend %input-text-styles
+  vertical-align: top
+
+////////////////////
+// Buttons
+////////////////////
+
+button, .input[type="button"], .input[type="reset"], .input[type="submit"]
+  appearance: none
+  background: none
+  border: none
+    radius: 2px

data/app/assets/stylesheets/admin/base/layout.sass

@@ -0,0 +1,6 @@
+////////////////////
+// Layout Structure 
+////////////////////
+
+body
+  background-color: $background-primary

data/app/assets/stylesheets/admin/base/lists.sass

@@ -0,0 +1,14 @@
+////////////////////
+// List Parents
+////////////////////
+
+.ol, .ul , .dl
+  margin: $rhythm-vertical 0
+  list-style-position: inside
+  .ol, .ul, .dl
+    margin: 0 0 0 $rhythm-horizontal
+.ol
+  list-style-type: decimal
+
+.ul
+  list-style-type: disc

data/app/assets/stylesheets/admin/base/scale.sass

@@ -0,0 +1,8 @@
+////////////////////
+// Scaling REM 
+////////////////////
+
+html
+  font-size: $small-rem
+  @media #{$large-up}
+    font-size: $base-rem

data/app/assets/stylesheets/admin/base/svg.sass

@@ -0,0 +1,9 @@
+////////////////////
+// SVG Defaults
+////////////////////
+
+svg
+  display: inline-block
+  fill: currentColor
+  height: $svg-size 
+  width: auto

data/app/assets/stylesheets/admin/base/tables.sass

@@ -0,0 +1,32 @@
+////////////////////
+// Tables
+////////////////////
+
+table
+  border:
+    collapse: $table-border-collapse
+    color: $table-border-color
+    width: $table-border-width
+  cell-spacing: 0
+  table-layout: fixed
+  width: $table-width
+  a
+    text-decoration: underline
+
+////////////////////
+// Table Elements
+////////////////////
+
+thead tr, tfoot tr
+  background: $table-header
+  color: dynamic-text-lightness($table-header)
+
+tr
+  background: $table-row-odd
+  text-align: left
+  &:nth-child(even)
+    background: $table-row-even
+
+td, th
+  padding: $rhythm
+  vertical-align: middle

data/app/assets/stylesheets/admin/base/type.sass

@@ -0,0 +1,120 @@
+////////////////////
+// Font Defaults
+////////////////////
+
+body
+  color: $font-color
+  font:
+    family: $font-family
+    size: $font-size
+    weight: $font-weight
+  line-height: $line-height
+
+////////////////////
+// Font Placeholders
+////////////////////
+
+%h-family
+  font:
+    family: $header-family
+    weight: $font-weight-bold
+
+////////////////////
+// Font Primary Elements
+////////////////////
+
+h1, .h1
+  @extend %h-family
+  font-size: $h1-size
+
+h2, .h2
+  @extend %h-family
+  font-size: $h2-size
+
+h3, .h3
+  @extend %h-family
+  font-size: $h3-size
+
+h4, .h4
+  @extend %h-family
+  font-size: $h4-size
+
+h5, .h5
+  @extend %h-family
+  font-size: $h5-size
+
+h6, .h6
+  @extend %h-family
+  font-size: $h6-size
+
+p
+  margin: $rhythm-vertical 0
+
+a
+  color: inherit
+  cursor: pointer
+
+////////////////////
+// Generic Text Selectors
+////////////////////
+
+b, strong
+  font-weight: $font-weight-bold
+
+i, em
+  font-style: italic
+
+u
+  text-decoration: underline
+
+strike
+  text-decoration: line-through
+
+sup, sub
+  font-size: $small-size
+  line-height: 0
+  position: relative
+  vertical-align: baseline
+
+sup
+  top: -.5em
+
+sub
+  bottom: -.25em
+
+small
+  font-size: $small-size
+
+abbr
+  border-bottom: $border-width dotted currentColor
+  cursor: help
+
+kbd, var
+  background: $background-secondary
+  font-family: $monospace-family
+
+q
+  &:before, &:after
+    content: '"'
+
+blockquote
+  background: $background-secondary
+  border-left: $border-width solid currentColor
+  padding-left: $border-width * 3
+
+cite
+  &:before
+    content: "–"
+
+//dfn
+
+mark
+  font-style: italic
+
+//samp
+
+//time
+
+//pre
+
+//code