aureus 1.0.0 → 1.1.0

data/.gitignore

@@ -0,0 +1 @@
+*.DS_Store

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aureus (1.0.0)
+    aureus (1.1.0)
       formtastic
       haml
       jquery-rails

data/Readme.md

@@ -1,14 +1,16 @@
-# Aureus Admin Template
+# Aureus
 
-**a nice looking css framework for your rails admin interfaces**
+**a nice looking framework for your rails admin interfaces**
+
+Aureus is a tool to quickly generate admin interfaces for a rails app. It's between scaffolding and tools like ActiveAdmin.
 
 ## Installation
 
 To use **aureus** simply require the gem:
 
-````ruby	
+````ruby
 gem "aureus"
-````
+```
 
 The rails engine will automatically load the following dependencies:
 	
@@ -21,10 +23,327 @@ But you have to ensure that these gems are available:
 * sass-rails
 * coffee-rails
 
-## Helper Methods
+## Asset Pipeline
+
+Aureus uses the rails asset pipeline to load and override the style and behavior.
+
+This is the basic application.scss setup:
+
+````scss
+/*
+*= require_self
+*= depend_on aureus
+*/
+
+$color_main: #0f0; // the color used for highlights
+$color_warn: #f00; // the color used for warning (should be red)
+
+@import "aureus";
+
+// your styles here ...
+```
+
+Configure the scripts in application.js:
+
+````js
+//= require_self
+//= require aureus
+
+var datepickerConfiguration = {
+  dayNamesMin: ['So','Mo','Di','Mi','Do','Fr','Sa'],
+  monthNames: ['Januar','Februar','März','April','Mai','Juni','Juli','August','September','Oktober','November','December'],
+  nextText: "→",
+  prevText: "←",
+  dateFormat: "yy-mm-dd",
+  firstDay: 1,
+}
+
+var timepickerConfiguration = {
+  isoTime: true,
+  minTime: {hour:6,minute:0},
+  maxTime: {hour:22,minute:0},
+  timInterval: 30
+}
+
+var tooltipConfiguration = {
+  background: "none",
+  color: 'black',
+  border: "none"
+}
+```
+
+## Helpers
+
+There are several helper methods available to generate the interface:
+
+````haml
+// Toolbar
+= aureus_toolbar "A nice title" do |t|
+	- t.left do |l|
+		- l.link_to "root", root_url
+		- l.link_to "an anchor", an_anchor_url
+		- l.info "cool"
+	- t.right do |r|
+		- r.info "some info"
+		- r.link_to "an anchor", some_other_controller_url
+
+// Navigation
+= aureus_navigation do |n|
+	- n.title "the title"
+	- n.button link_to("target name",some_cool_url) if can? :read, Stuff
+	- n.submit_form_button @post, "save"
+
+// Flash messages
+= aureus_messages flash
+
+// Content wrapper for layout
+= aureus_content yield
+
+// Grid system (with automatic proportion calculation)
+= aureus_row do
+	%strong only wrapper
+= aureus_row do |r|
+	- r.column 100 do
+		.one-column
+= aureus_row do |r|
+	- r.column 2 do # two '2 width' colums are the same like 50 / 50
+		.first
+	- r.space 2
+= aureus_row do |r|
+	- r.column 25 do
+		.first
+	- r.column 25 do
+		.second
+	- r.column 50 do
+		.third
+
+// Boxes
+= aureus_box "a title" do
+	%strong content
+= aureus_box "a title", :centered => true, :for => :form do
+	%li a entry
+= aureus_box "a title" do |b|
+	- b.button link_to("a button",cool_controller_url)
+	- b.content do
+		%strong the content
+	- b.foot do
+		%strong the footer
+
+// Datatables
+= aureus_datatable @resources do |t|
+	- t.head do |h|
+		- h.text "Title"
+		- h.text "Text"
+		- h.date "Date"
+		- h.raw "Raw"
+	- t.row do |r,res|
+		- r.cell res.title
+		- r.cell res.text
+		- r.cell res.date
+		- r.cell res.unsortable_data
+		- r.button :show, "url" if can? :show, Resource
+		- r.button :edit, "url"
+		- r.button :destroy, "url", :confirm => "Delete user?"
+		- r.button_raw link_to("a action",the_action_url, :class => ["icon","my-icon"])
+
+// Forms
+= aureus_form [@parent,@resource] do |f|
+	= f.input :name # formtastic is here
+
+// Listings
+= aureus_listing do |l|
+	- l.entry "head", "body"
+	- l.entry "head2" do
+		%strong body2
+
+// Maps (Google Maps iFrame)
+= aureus_map :longitude => 12, :latitude => 6
+````
+
+## Generators
+
+Aureus has a bunch of generators builtin to easily generate a complete interface including i18n.
+
+### Layout
+
+To generate a base layout issue `rails g aureus:layout layout_name` which produces:
+
+````haml
+!!! 5
+%html
+  %head
+    %meta{ :charset => "utf-8" }/
+    %title= t(".title")
+    = stylesheet_link_tag "application"
+    = javascript_include_tag "application"
+    = csrf_meta_tag
+  %body
+    = aureus_toolbar t(".title") do |t|
+      - t.left do |l|
+        - l.link_to t(".root"), root_url
+      - t.right do |r|
+        - r.info "info"
+    = yield :navigation
+    = aureus_messages flash
+    = aureus_content yield
+```
 
+Add the I18n keys to your en.yml.
+
+### Views
+
+The awesome thing about aureus is the following generator `rails g aureus:views Resource ResourcesController` which generates all views and i18n files for you. It uses your ActiveRecord model to determine all attributes and uses the controller name for proper folders. The above command will generate:
+
+#### app/views/resources/index.html.haml
+
+````haml
+- content_for :navigation do
+  = aureus_navigation do |n|
+    - n.title t(".title")
+    - n.button link_to(t(".button_new"), new_resource_url) if can? :create, Resource
+
+= render "list"
+````
+
+#### app/views/resources/show.html.haml
+
+````haml
+- content_for :navigation do
+  = aureus_navigation do |n|
+    - n.title t(".title")
+    - n.button link_to(t(".button_edit"), edit_resource_url(@resource)) if can? :update, Resource
+    - n.button link_to(t(".button_back"),resources_url) if can? :index, Resource
+
+= render "item"
+````
+
+#### app/views/resources/new.html.haml
+
+````haml
+- content_for :navigation do
+  = aureus_navigation do |n|
+    - n.title t(".title")
+    - n.button link_to(t(".button_cancel"), resources_url) if can? :index, Resource
+    - n.submit_form_button @resource, t(".button_save") if can? :create, Resource
+
+= render "form"
+````
+
+#### app/views/resources/edit.html.haml
+
+````haml
+- content_for :navigation do
+  = aureus_navigation do |n|
+    - n.title t(".title")
+    - n.button link_to t(".button_cancel"), resources_url if can? :show, Resource
+    - n.submit_form_button @resource, t(".button_save") if can? :update, Resource
+
+= render "form"
+````
+
+#### app/views/resources/_list.html.haml
+
+````haml
+= aureus_row do
+  = aureus_box t(".box_title") do
+    = aureus_datatable @resources do |t|
+      - t.head do |h|
+        - h.text t(".column_id")
+        - h.text t(".column_name")
+        - h.text t(".column_body")
+        - h.text t(".column_description")
+        - h.text t(".column_created_at")
+        - h.text t(".column_updated_at")
+      - t.row do |r,resource|
+        - r.cell resource.id
+        - r.cell resource.name
+        - r.cell resource.body
+        - r.cell resource.description
+        - r.cell resource.created_at
+        - r.cell resource.updated_at
+        - r.button :show, resource_url(resource) if can? :show, Resource
+        - r.button :edit, edit_resource_url(resource) if can? :edit, Resource
+        - r.button :destroy, resource_url(resource), :confirm => t(".destroy_confirm") if can? :destroy, Resource
+````
+
+#### app/views/resources/_form.html.haml
+
+````haml
+= aureus_form [@resource] do |f|
+  = aureus_row do |r|
+    - r.column 25 do
+      = aureus_box t(".box_title"), :for => :form do
+        = f.input :name, :label => t(".field_name")
+        = f.input :body, :label => t(".field_body")
+        = f.input :description, :label => t(".field_description")
+    - r.space 75
+````
+
+#### app/views/resources/_item.html.haml
+
+````haml
+= aureus_row do |r|
+  - r.column 25 do
+    = aureus_box t(".box_title") do
+      = aureus_listing do |l|
+        - l.entry t(".entry_id"), @resource.id
+        - l.entry t(".entry_name"), @resource.name
+        - l.entry t(".entry_body"), @resource.body
+        - l.entry t(".entry_description"), @resource.description
+        - l.entry t(".entry_created_at"), @resource.created_at
+        - l.entry t(".entry_updated_at"), @resource.updated_at
+  - r.space 75
+````
+
+#### config/locales/resources.en.yml
+
+````yml
+en:
+  resources:
+    index:
+      title: Resources
+      button_new: Add Resource
+    new:
+      title: New Resource
+      button_cancel: Cancel
+      button_save: Save
+    edit:
+      title: Edit Resource
+      button_cancel: Cancel
+      button_save: Save
+    form:
+      box_title: Details
+      field_id: Id
+      field_name: Name
+      field_body: Body
+      field_description: Description
+      field_created_at: Created At
+      field_updated_at: Updated At
+    list:
+      box_title: Resources Listing
+      destroy_confirm: Really want to delete the Resource?
+      column_id: Id
+      column_name: Name
+      column_body: Body
+      column_description: Description
+      column_created_at: Created At
+      column_updated_at: Updated At
+    show:
+      title: Resource
+      button_edit: Edit Resource
+      button_back: Back
+    item:
+      box_title: Details
+      entry_id: Id
+      entry_name: Name
+      entry_body: Body
+      entry_description: Description
+      entry_created_at: Created At
+    	entry_updated_at: Updated At
+````
 
+### Devise
 
-## The Layout
+Therer are serveral generators to nicely integrate devise with aureus.
 
-Here is a simple layout done with aureus helpers:
+Use `rails g aureus:devise_views folder` where folder is basically devise or namespace/devise, to generate aureus compatible devise views. These views are all set with I18n keys so you need to generate them too: `rails g aureus:devise_i18n` which generates 3 files with all keys set in english. Remove your devise.en.yml to have no duplication.

data/TODO.md

@@ -2,6 +2,6 @@
 
 * box head buttons
 * datatable improvements
+* datatable i18n
 * proper namespace css and clean up
-* update javascripts
-* datatable i18n
+* update javascripts

data/app/assets/stylesheets/aureus/table.scss

@@ -79,7 +79,7 @@
         @include border-radius(30px);
         @include gradient(#eee,#ccc);
         border: 1px solid #999;
-        margin: 0 1px;
+        margin: 0 2px;
         span {
           color: #555;
           text-decoration: none;
@@ -88,7 +88,7 @@
           text-shadow: 1px 1px 0 #eee;
         }
       }
-      a.edit, a.destroy, a.show, a.recover, a.print {
+      a.edit, a.destroy, a.show, a.recover, a.print, a.icon {
         width: 16px;
         height: 16px;
         display: inline-block;

data/aureus.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   # Main Info
   s.name = "aureus"
   s.version = Aureus::VERSION
-  s.summary = "Aureus Admin Template"
-  s.description = "Aureus Admin Template"
+  s.summary = "a nice looking framework for your rails admin interfaces"
+  s.description = "Aureus is a tool to quickly generate admin interfaces for a rails app. It's between scaffolding an tools like ActiveAdmin."
   s.license = "MIT"
 
   # Additional Info
@@ -17,8 +17,8 @@ Gem::Specification.new do |s|
   s.homepage = "https://github.com/256dpi/aureus"
   
   # Files
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
 
   # Dependencies
   s.add_dependency "formtastic"

data/lib/aureus/box.rb

@@ -6,6 +6,7 @@ module Aureus
 			init options, :for => :text, :centered => false
 			init_haml_helpers
 			@title = title
+			@buttons = Array.new
 			@content = capture_haml self, &block
 		end
 
@@ -17,8 +18,12 @@ module Aureus
 			@foot = capture_haml &block
 		end
 
+		def button content
+			@buttons << BoxButton.new(content)
+		end
+
 		def render
-			title = content_tag("h3",@title)
+			title = content_tag("h3",compact(content_tag("span",@title),compact_render(*@buttons)))
 			classes = ["box"]
 			classes << "centered" if @options[:centered]
 			@content = @new_content if not @new_content.nil?
@@ -34,4 +39,16 @@ module Aureus
 
 	end
 
+	class BoxButton < Renderable
+
+		def initialize content
+			@content = content
+		end
+
+		def render
+			@content
+		end
+
+	end
+
 end

data/lib/aureus/data_table.rb

@@ -2,9 +2,9 @@ module Aureus
 
 	class DataTable < Renderable
 
-		def initialize resource, toolbar = true
+		def initialize resource, args
+			init args, { :toolbar => true }
 			@resource = resource
-			@toolbar = toolbar
 			@head = DataTableHead.new
 			@rows = Array.new
 		end
@@ -22,7 +22,7 @@ module Aureus
 		end
 
 		def render
-			content_tag "table", :id => @resource.class.name.downcase, :class => (@toolbar?"datatable":"datatable-no-toolbar") do
+			content_tag "table", :id => @resource.class.name.downcase, :class => (@options[:toolbar] ? "datatable":"datatable-no-toolbar") do
 				compact @head.render, content_tag("tbody",compact_render(*@rows))
 			end
 		end
@@ -72,12 +72,17 @@ module Aureus
 	class DataTableRow < Renderable
 
 		def initialize
+			init_haml_helpers
 			@cells = Array.new
 			@buttons = Array.new
 		end
 
-		def cell data
-			@cells << DataTableRowCell.new(data)
+		def cell data="", &block
+			if block_given?
+				@cells << DataTableRowCell.new(capture_haml(&block))
+			else
+				@cells << DataTableRowCell.new(data)
+			end
 		end
 
 		def button type_or_title, url, *args
@@ -88,6 +93,10 @@ module Aureus
 			end
 		end
 
+		def button_raw content
+			@buttons << Renderable.new(content)
+		end
+
 		def render
 			content_tag "tr", compact_render(*@cells)+content_tag("td",compact_render(*@buttons),:class => "buttons")
 		end

data/lib/aureus/helper.rb

@@ -33,8 +33,8 @@ module Aureus
 			box.render
 		end
 
-		def aureus_datatable resource
-			table = DataTable.new resource
+		def aureus_datatable resource, *args
+			table = DataTable.new resource, args
 			yield table
 			table.render
 		end
@@ -51,6 +51,11 @@ module Aureus
 			listing.render
 		end
 
+		def aureus_map *args
+			map = Map.new args
+			map.render
+		end
+
 	end
 
 end

data/lib/aureus/map.rb

@@ -0,0 +1,17 @@
+module Aureus
+
+	class Map < Renderable
+
+		def initialize args
+			init args, {}
+		end
+
+		def render
+			if @options[:longitude] and @options[:latitude]
+				content_tag("iframe","",:src => "https://maps.google.ch/maps?q="+@options[:latitude].to_s+","+@options[:longitude].to_s+"&ie=UTF8&z=15&output=embed", :width => @options[:width], :height => @options[:height])
+			end
+		end
+
+	end
+
+end

data/lib/aureus/row.rb

@@ -27,19 +27,19 @@ module Aureus
 				end
 				out = String.new.html_safe
 				@columns.each_with_index do |c,i|
-					left = 1
-					right = 1
+					left = 0.5
+					right = 0.5
 					width = (100.0 / total_width * c.width).round
 					if i == 0
 						left = 0
-						width -= 1
+						width -= 0.5
 					elsif i == @columns.length-1
 						right = 0
-						width -= 1
+						width -= 0.5
 					else
-						width -= 2
+						width -= 1
 					end
-					out += content_tag "div", c.content, :style => "width: #{width}%; margin_left: #{left}%; margin_right: #{right}%"
+					out += content_tag "div", c.content, :class => :column, :style => "width: #{width}%; margin-left: #{left}%; margin-right: #{right}%"
 				end
 				content_tag "div", out, :class => "row"
 			end

data/lib/aureus/version.rb

@@ -1,3 +1,3 @@
 module Aureus
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/aureus.rb

@@ -17,6 +17,7 @@ module Aureus
 	autoload :DataTable
 	autoload :Form
 	autoload :Listing
+	autoload :Map
 
 	class Renderable
 		include ActionView::Context
@@ -25,6 +26,10 @@ module Aureus
 		include ActionView::Helpers::UrlHelper
 		include Haml::Helpers
 
+		def initialize content
+			@content = content
+		end
+
 		def init args, *defaults
 			@options = defaults.extract_options!.merge args.extract_options!
 		end
@@ -49,6 +54,10 @@ module Aureus
 			out
 		end
 
+		def render
+			@content
+		end
+
 	end
 
 end

data/lib/generators/aureus/layout/layout_generator.rb

@@ -0,0 +1,19 @@
+module Aureus
+
+	module Generators
+
+		class LayoutGenerator < Rails::Generators::Base
+
+			desc "generate an aureus layout file"
+			source_root File.expand_path("../templates", __FILE__)
+			argument :name, :required => true
+
+			def generate
+				copy_file "layout.html.haml", "app/views/layouts/"+name+".html.haml"
+			end
+
+		end
+
+	end
+
+end

data/lib/generators/aureus/layout/templates/layout.html.haml

@@ -0,0 +1,17 @@
+!!! 5
+%html
+  %head
+    %meta{ :charset => "utf-8" }/
+    %title= t(".title")
+    = stylesheet_link_tag "application"
+    = javascript_include_tag "application"
+    = csrf_meta_tag
+  %body
+    = aureus_toolbar t(".title") do |t|
+      - t.left do |l|
+        - l.link_to t(".root"), root_url
+      - t.right do |r|
+        - r.info "info"
+    = yield :navigation
+    = aureus_messages flash
+    = aureus_content yield

data/lib/generators/aureus/views/templates/views/_form.html.haml

@@ -1,4 +1,4 @@
-= aureus_form [{{{FORM_PATH}}},@{{{NAME_SINGULAR}}}] do |f|
+= aureus_form [{{{FORM_PATH}}}] do |f|
   = aureus_row do |r|
     - r.column 25 do
       = aureus_box t(".box_title"), :for => :form do

data/lib/generators/aureus/views/views_generator.rb

@@ -16,6 +16,7 @@ module Aureus
 				target = ["app/views",folder].join "/"
 				namespace = folder.split("/").slice(0...-1)
 				model = model_name.constantize
+				controller_test = controller.constantize
 				columns = model.column_names
 				columns2 = columns - ["id","created_at","updated_at"]
 				real_name = model_name.demodulize
@@ -33,7 +34,7 @@ module Aureus
 						"TABLE_CELLS" => columns.collect{ |c| '        - r.cell '+real_name.downcase+'.'+c }.join("\n"),
 						"ENTRIES" => columns.collect{ |c| '        - l.entry t(".entry_'+c+'"), @'+real_name.downcase+'.'+c }.join("\n"),
 						"INPUTS" => columns2.collect{ |c| '        = f.input :'+c+', :label => t(".field_'+c+'")' }.join("\n"),
-						"FORM_PATH" => namespace.collect{ |n| '"'+n+'"' }.join(",")
+						"FORM_PATH" => namespace.collect{ |n| '"'+n+'"' }.push("@"+real_name.downcase).join(",")
 					}
 					Dir[target+"/*.haml"].each do |file|
 						replacements.each do |key,value|
@@ -52,7 +53,7 @@ module Aureus
       				"new" => { "title" => "New "+singular, "button_cancel" => "Cancel", "button_save" => "Save" },
       				"edit" => { "title" => "Edit "+singular, "button_cancel" => "Cancel", "button_save" => "Save" },
       				"form" => { "box_title" => "Details" },
-      				"list" => { "box_title" => plural+" Listing" },
+      				"list" => { "box_title" => plural+" Listing", "destroy_confirm" => "Really want to delete the "+singular+"?" },
       				"show" => { "title" => singular, "button_edit" => "Edit "+singular, "button_back" => "Back" },
       				"item" => { "box_title" => "Details" }
       			}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aureus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-20 00:00:00.000000000 Z
+date: 2012-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: formtastic
@@ -59,12 +59,14 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Aureus Admin Template
+description: Aureus is a tool to quickly generate admin interfaces for a rails app.
+  It's between scaffolding an tools like ActiveAdmin.
 email: joel.gaehwiler@bluewin.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
 - Gemfile.lock
 - Rakefile
@@ -106,6 +108,7 @@ files:
 - lib/aureus/engine.rb
 - lib/aureus/helper.rb
 - lib/aureus/listing.rb
+- lib/aureus/map.rb
 - lib/aureus/messages.rb
 - lib/aureus/navigation.rb
 - lib/aureus/row.rb
@@ -130,6 +133,8 @@ files:
 - lib/generators/aureus/devise_views/templates/devise/sessions/new.html.haml
 - lib/generators/aureus/devise_views/templates/devise/shared/_links.html.haml
 - lib/generators/aureus/devise_views/templates/devise/unlocks/new.html.haml
+- lib/generators/aureus/layout/layout_generator.rb
+- lib/generators/aureus/layout/templates/layout.html.haml
 - lib/generators/aureus/views/templates/views/_form.html.haml
 - lib/generators/aureus/views/templates/views/_item.html.haml
 - lib/generators/aureus/views/templates/views/_list.html.haml
@@ -155,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 36369560526985559
+      hash: -3013022047789676668
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -164,13 +169,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 36369560526985559
+      hash: -3013022047789676668
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Aureus Admin Template
+summary: a nice looking framework for your rails admin interfaces
 test_files:
 - test/html.haml
 - test/model.rb