comfy-admin-constructor 0.1.18 → 0.1.19

data/README.md

@@ -1,29 +1,77 @@
-# Comfy::Admin::Constructor
+# ComfyAdminConstructor
 
-TODO: Write a gem description
+**ComfyAdminConstructor** allows you to quickly and easily build basic admin interfaces in [ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa).
 
-## Installation
+Installation
+------------
 
-Add this line to your application's Gemfile:
+Add gem definition to your **Gemfile**:
 
-    gem 'comfy-admin-constructor'
+      gem 'comfy-admin-constructor'
 
-And then execute:
+Then, from the Rails project's root run:
 
-    $ bundle
+      bundle install
 
-Or install it yourself as:
+Requirements
+------------
 
-    $ gem install comfy-admin-constructor
+There are plans to make CAC more flexible in the future, but right now it assumes a few things about your CMS install:
 
-## Usage
+* You access CMS at **/admin** and not /cms-admin
+* You use HAML and SASS
+* You don't store your models in sub-directories
+* Your admin controllers and views are stored in **controllers/admin** and **views/admin**, respectively
+* Your CMS initializer will need to specify a custom navigation template at **views/admin/_navigation.html.haml***
 
-TODO: Write usage instructions here
+Planned Features
+----------------
 
-## Contributing
+* More flexibility in where/how things are created
+* Basic passing tests
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Quick Start Guide
+-----------------
+
+**Before proceeding make sure you have CMS up and running, taking into account the requirements above.** Make sure you've created your first site.
+
+All done? Good. Let's walk through creating your first admin interface using CAC.
+
+Let's say my application needs a way to create/edit event listings. Some of the fields we might need include:
+
+* Event title
+* Start date/time
+* End date/time
+* Description
+* Location
+
+With CAC, this is easy. In the root of the Rails project, we simply type:
+
+      rails g cms_admin EventListing title:string starts_at:datetime ends_at:datetime description:text location:string
+
+CAC will automatically generate a bunch of files for us:
+
+      create  app/models/event_listing.rb
+      create  db/migrate/20120721145844_create_event_listings.rb
+      create  app/controllers/admin/event_listings_controller.rb
+      create  app/views/admin/event_listings/_form.html.haml
+      create  app/views/admin/event_listings/edit.html.haml
+      create  app/views/admin/event_listings/index.html.haml
+      create  app/views/admin/event_listings/new.html.haml
+       route  namespace(:admin){ resources :event_listings, :except => [:show] }
+
+So, what happened there?
+
+* The EventListing model was generated, with basic **:presence => :true** validation for all attributes
+* A migration was generated to create the necessary table for our database (Note: Migrations are **never** run automatically. That's on you.)
+* A controller, complete with ActiveRecord rescues, success/failure flash messages, and more.
+* Views for all the operations we'll need, along with a form.
+* Added a new route
+* Appended a new link to the navigation template
+
+That's it! CAC gives you all the basics. If you need to do something a little more complicated, it's easy to make any changes you like.
+
+---
+
+ComfortableMexicanSofa is released under the [MIT license](https://github.com/bgilham/comfy-admin-constructor/blob/master/LICENSE) 
+Copyright 2012 Brian Gilham, [The Working Group Inc](http://www.twg.ca)

data/comfy-admin-constructor.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/comfy-admin-constructor/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Brian Gilham"]
   gem.email         = ["me@briangilham.com"]
-  gem.description   = "Generate a new CMS admin section by providing a model name, along with attributes. ***NOT READY FOR USE***"
-  gem.summary       = "Comfy Admin Constructor - Create CMS admin sections in one line ***NOT READY FOR USE***"
+  gem.description   = "ComfyAdminConstructor allows you to quickly and easily build basic admin interfaces in ComfortableMexicanSofa."
+  gem.summary       = "Comfy Admin Constructor - Create CMS admin sections in one line"
   gem.homepage      = "https://github.com/bgilham/comfy-admin-constructor"
 
   gem.files         = `git ls-files`.split($\)

data/lib/comfy-admin-constructor/version.rb

@@ -1,7 +1,7 @@
 module Comfy
   module Admin
     module Constructor
-      VERSION = "0.1.18"
+      VERSION = "0.1.19"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comfy-admin-constructor
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
   prerelease: 
 platform: ruby
 authors:
@@ -11,8 +11,8 @@ bindir: bin
 cert_chain: []
 date: 2012-07-21 00:00:00.000000000Z
 dependencies: []
-description: Generate a new CMS admin section by providing a model name, along with
-  attributes. ***NOT READY FOR USE***
+description: ComfyAdminConstructor allows you to quickly and easily build basic admin
+  interfaces in ComfortableMexicanSofa.
 email:
 - me@briangilham.com
 executables: []
@@ -69,6 +69,5 @@ rubyforge_project:
 rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: Comfy Admin Constructor - Create CMS admin sections in one line ***NOT READY
-  FOR USE***
+summary: Comfy Admin Constructor - Create CMS admin sections in one line
 test_files: []