brick_layer 0.9.0

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+db/*.sqlite3
+tmp/**/*
+.DS_Store

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem 'rails',    '>= 3.1.0'
+gem 'sqlite3'
+
+# Asset template engines
+gem 'sass-rails', "~> 3.1.0"
+gem 'coffee-script'
+gem 'uglifier'
+
+gem 'jquery-rails'
+
+gemspec

data/README.rdoc

@@ -0,0 +1,278 @@
+= Brick Layer
+
+The concept behind Brick Layer is to have a site manager that includes CMS as a feature. It should be easy 
+to plug into any Rails 3.1 application. It provides the bare minimum support to get up and rolling quickly
+with a basic CRUD data management system that easily outputs JSON as an alternative format by default.
+
+== Features
+
+* CRUD and RESTful DataSet Support
+  - If you just need to have a system of any kind of data that outputs to json
+  
+* Search Support
+  - Searching across a certain set of data or all data sets should be easy
+
+* Routing Support
+  - Easily tie a route to a certain data set endpoint
+
+* Auto UI Generation
+  - Allow the dataset definitions to generate your user interface for you
+  
+*[TODO] User Authentication (For now you can roll your own)
+  - Don't allow anyone to pop into the admin, this control is already installed
+  
+* Custom Config API
+  - Easily ping the app to get JSON format delivery of existing Routes and other configuration
+
+== Requirements
+
+- Right now this requires Mongo which currently provides the maximum flexibility in what the use cases are.
+
+== Installation
+
+Add the gem to your Rails 3.1 application Gemfile and that's it!
+
+  gem 'brick_layer'
+
+Also in your 'app/assets/stylesheets' directory add:
+  //= require brick_layer
+
+== Data Sets
+
+To define a data set:
+  
+# You can name your data set whatever you want, but you probably want to try and end it with "DataSet" as a convention
+  
+  class ShipDataSet < BrickLayer::DataSet
+    field :name,  type: String
+    field :size,   type: String
+  end
+
+This will include the timestamps and text search abilities (if you need them) by default. After creating a data set or a few, it should be accessible via:
+
+  http://<host>:<port>/brick_layer/data-sets/ship_data_sets
+OR EVEN BETTER
+  http://<host>:<port>/brick_layer/data-sets/ship_data_sets.json
+
+If you want to make a method accessible in the data set json you can just:
+
+  class ShipDataSet < BrickLayer::DataSet
+    field :name,   type: String
+    field :size,   type: String
+    
+    expose_data :my_method
+    
+    def my_method(options={})
+      "result from my method"
+    end
+  end
+
+This will make the method's result available in the json in the format:
+  
+  { my_method: "result from method" }
+  
+The options variable is there to support changing up the data if you want for some reason. The default html view on a page data set will pass { :html => true } as an option
+to the exposed data method. So you can format the display of exposed data methods if you want.
+
+  class ShipDataSet < BrickLayer::DataSet
+    field :name,   type: String
+    field :size,   type: String
+  
+    expose_data :my_method
+  
+    def my_method(options={})
+      if options[:html]
+        "something that is readable in an html view"
+      else
+        "some other format for json display"
+      end
+    end
+  end
+
+== CRUD and Auto Form Builder
+
+There is a built in auto-crud system with simple styles to handle quickly adding data to the database.
+
+Brick Layer is using simple form to help support the auto building for HTML5 forms for custom field types. You can find out more about
+simple form at https://github.com/plataformatec/simple_form
+
+Using the UI form builder is fairly easy. It'll automatically read the fields you define on a model and display them correctly.
+
+Let's say we define a standalone data set like:
+
+  class Product < BrickLayer::DataSet
+    field :name,          type: String
+    field :release_date,  type: DateTime
+    field :publish,       type: Boolean
+  end
+
+Then we head over to:
+
+  http://<host>:<port>/brick_layer/data-sets/products
+
+From there will be able to create a new product and the fields will be formatted to match the data types we've described here.
+
+Now, I know what you are thinking - what about when I want to have a file field or something similar. That's easy to:
+
+  class Product < BrickLayer::DataSet
+    field :name,          type: String
+    field :release_date,  type: DateTime
+    field :publish,       type: Boolean
+    
+    custom_field :description,    :text
+    custom_field :website,        :url
+    custom_field :phone,          :phone
+    custom_field :avatar,         :image # This requires you have imagemagick installed
+  end
+
+All you have to do is say 'custom_field_type' with whatever mapping that is supported by simple form.
+
+You can pass simple form supported options into your custom field to enable the built in WYSIWYG editor or whatever else you want to pass to the view.
+
+  class Product < BrickLayer::DataSet
+    custom_field :description, :text, { :input_html => { :class => "withEditor" } }
+  end
+
+
+Relationships are also supported so you can add those and the fields should automatically show up.
+
+  class Owner < BrickLayer::DataSet
+    field :name
+  
+    has_one :company, autosave: true
+      
+    def to_s
+      self.name
+    end
+  end
+
+  class Company < BrickLayer::DataSet
+    field :name
+  
+    belongs_to :owner
+    has_many   :employees, autosave: true
+      
+    def to_s
+      self.name
+    end
+  end
+
+  class Employee < BrickLayer::DataSet
+    belongs_to :company
+  
+    field :first_name,        type: String
+    field :last_name,         type: String
+    field :dob,               type: DateTime
+  end
+
+The defined "to_s" method will be used when displaying item information in the form fields.
+
+== Admin UI Control (CUSTOM DATA SET LINKS)
+
+If you choose to use the view navigation outside of just using URLs you can add the standalone classes you want to show in an initializer file.
+
+  # config/initializers/brick_layer_init.rb (or whatever you want)
+  
+  BrickLayer.data_sets_standalones = [:companies, :employees]
+
+This will add these classes to the "Custom Data Sets Link" in the admin navigation and also initialize the navigation link to show all together.
+
+
+== Admin UI Control (ROUTES and PAGES)
+
+The concept behind the admin of brick layer when it comes to pages is that you don't have to use them unless you want to. 
+In order to get a page (which is basically a route with a data set) requires little work. There is a conventional way of using pages.
+
+First you have to enable page support by adding this configuration to your initializer file:
+  
+  # config/initializers/brick_layer_init.rb (or whatever you want)
+  
+  BrickLayer.enable_pages = true
+
+Once that is done you'll get a pages link that'll allow you to create new routes and attach data sets to them. So the way this works is that you define
+your dataset for page just like any other dataset. Except you put it in your models/page_data_sets/directory (this is a convention)
+
+
+  # app/models/page_data_sets/home_page
+  
+  class PageDataSets::HomePage < BrickLayer::DataSet
+    belongs_to :company
+
+    field :welcome_message,   type: String
+    field :blurb,             type: String
+
+    custom_field :welcome_message, :text
+  end
+
+Once you do this and you go to create a route you'll get the option to select the data set associated with the route. Once you create the route it'll redirect
+you to the edit page for that route which will show the custom form fields associated with that page. That's it!
+
+So all you have to do at this point is create data sets that you want to associate with a page that'll be made available when you request the page. Don't forget
+that you can aggregate more data on a page as well.
+
+For example, let's say you have a product custom data set already and you want to display the 10 most recent on the homepage. You can do this:
+
+  # app/models/page_data_sets/home_page
+
+  class PageDataSets::HomePage < BrickLayer::DataSet
+    belongs_to :company
+
+    field :welcome_message,   type: String
+    field :blurb,             type: String
+
+    custom_field :welcome_message, :text
+  
+    expose_data :most_recent_products
+  
+    def most_recent_products(options={})
+      DummyCompany.order_by(:created_at,"DESC").limit(10)
+    end
+  end
+  
+That data will be made available for that page attached to that route!
+
+Also, let's say that you want to give the administrator control over what the limit to display on that page is. No sweat, you would:
+
+  # app/models/page_data_sets/home_page
+
+  class PageDataSets::HomePage < BrickLayer::DataSet
+    belongs_to :company
+
+    field :welcome_message,   type: String
+    field :blurb,             type: String
+    field :limit,             type: Integer
+
+    custom_field :welcome_message, :text
+  
+    expose_data :most_recent_products
+  
+    def most_recent_productss(options={})
+      product_limit = 10 || self.limit
+      DummyCompany.order_by(:created_at,"DESC").limit(product_limit)
+    end
+  end
+  
+You can access this data at:
+   http://<host>:<port>/brick_layer/your-route-here
+AND OF COURSE in JSON!
+    http://<host>:<port>/brick_layer/your-route-here.json
+
+== Search
+
+To search all data sets you can ping the url with the path to search and pass it params. The search supports most mongo queries.
+
+So you can:
+
+  http://<host>:<port>/brick_layer/data-sets/search?title_in="document title"
+
+If you want to search on a specific data set just pass it in as a model param:
+  
+  http://<host>:<port>/brick_layer/data-sets/search?title_in="document title"&models="ship_data_set"
+
+You can also chain queries together:
+  
+  http://<host>:<port>/brick_layer/data-sets/search?queries[title_in]="document title"&queries[meta_description_in] = "meta description"
+
+Just add .json to the end of 'search' and you get results in json format:
+  
+  http://<host>:<port>/brick_layer/data-sets/search.json?title_in="document title"

data/Rakefile

@@ -0,0 +1,36 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BrickLayer'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/tiny_mce/langs/en.js

@@ -0,0 +1 @@
+tinyMCE.addI18n({en:{common:{"more_colors":"More Colors...","invalid_data":"Error: Invalid values entered, these are marked in red.","popup_blocked":"Sorry, but we have noticed that your popup-blocker has disabled a window that provides application functionality. You will need to disable popup blocking on this site in order to fully utilize this tool.","clipboard_no_support":"Currently not supported by your browser, use keyboard shortcuts instead.","clipboard_msg":"Copy/Cut/Paste is not available in Mozilla and Firefox.\nDo you want more information about this issue?","not_set":"-- Not Set --","class_name":"Class",browse:"Browse",close:"Close",cancel:"Cancel",update:"Update",insert:"Insert",apply:"Apply","edit_confirm":"Do you want to use the WYSIWYG mode for this textarea?","invalid_data_number":"{#field} must be a number","invalid_data_min":"{#field} must be a number greater than {#min}","invalid_data_size":"{#field} must be a number or percentage",value:"(value)"},contextmenu:{full:"Full",right:"Right",center:"Center",left:"Left",align:"Alignment"},insertdatetime:{"day_short":"Sun,Mon,Tue,Wed,Thu,Fri,Sat,Sun","day_long":"Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday","months_short":"Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec","months_long":"January,February,March,April,May,June,July,August,September,October,November,December","inserttime_desc":"Insert Time","insertdate_desc":"Insert Date","time_fmt":"%H:%M:%S","date_fmt":"%Y-%m-%d"},print:{"print_desc":"Print"},preview:{"preview_desc":"Preview"},directionality:{"rtl_desc":"Direction Right to Left","ltr_desc":"Direction Left to Right"},layer:{content:"New layer...","absolute_desc":"Toggle Absolute Positioning","backward_desc":"Move Backward","forward_desc":"Move Forward","insertlayer_desc":"Insert New Layer"},save:{"save_desc":"Save","cancel_desc":"Cancel All Changes"},nonbreaking:{"nonbreaking_desc":"Insert Non-Breaking Space Character"},iespell:{download:"ieSpell not detected. Do you want to install it now?","iespell_desc":"Check Spelling"},advhr:{"delta_height":"","delta_width":"","advhr_desc":"Insert Horizontal Line"},emotions:{"delta_height":"","delta_width":"","emotions_desc":"Emotions"},searchreplace:{"replace_desc":"Find/Replace","delta_width":"","delta_height":"","search_desc":"Find"},advimage:{"delta_width":"","image_desc":"Insert/Edit Image","delta_height":""},advlink:{"delta_height":"","delta_width":"","link_desc":"Insert/Edit Link"},xhtmlxtras:{"attribs_delta_height":"","attribs_delta_width":"","ins_delta_height":"","ins_delta_width":"","del_delta_height":"","del_delta_width":"","acronym_delta_height":"","acronym_delta_width":"","abbr_delta_height":"","abbr_delta_width":"","cite_delta_height":"","cite_delta_width":"","attribs_desc":"Insert/Edit Attributes","ins_desc":"Insertion","del_desc":"Deletion","acronym_desc":"Acronym","abbr_desc":"Abbreviation","cite_desc":"Citation"},style:{"delta_height":"","delta_width":"",desc:"Edit CSS Style"},paste:{"plaintext_mode_stick":"Paste is now in plain text mode. Click again to toggle back to regular paste mode.","plaintext_mode":"Paste is now in plain text mode. Click again to toggle back to regular paste mode. After you paste something you will be returned to regular paste mode.","selectall_desc":"Select All","paste_word_desc":"Paste from Word","paste_text_desc":"Paste as Plain Text"},"paste_dlg":{"word_title":"Use Ctrl+V on your keyboard to paste the text into the window.","text_linebreaks":"Keep Linebreaks","text_title":"Use Ctrl+V on your keyboard to paste the text into the window."},table:{"merge_cells_delta_height":"","merge_cells_delta_width":"","table_delta_height":"","table_delta_width":"","cellprops_delta_height":"","cellprops_delta_width":"","rowprops_delta_height":"","rowprops_delta_width":"",cell:"Cell",col:"Column",row:"Row",del:"Delete Table","copy_row_desc":"Copy Table Row","cut_row_desc":"Cut Table Row","paste_row_after_desc":"Paste Table Row After","paste_row_before_desc":"Paste Table Row Before","props_desc":"Table Properties","cell_desc":"Table Cell Properties","row_desc":"Table Row Properties","merge_cells_desc":"Merge Table Cells","split_cells_desc":"Split Merged Table Cells","delete_col_desc":"Delete Column","col_after_desc":"Insert Column After","col_before_desc":"Insert Column Before","delete_row_desc":"Delete Row","row_after_desc":"Insert Row After","row_before_desc":"Insert Row Before",desc:"Insert/Edit Table"},autosave:{"warning_message":"If you restore the saved content, you will lose all the content that is currently in the editor.\n\nAre you sure you want to restore the saved content?","restore_content":"Restore auto-saved content.","unload_msg":"The changes you made will be lost if you navigate away from this page."},fullscreen:{desc:"Toggle Full Screen Mode"},media:{"delta_height":"","delta_width":"",edit:"Edit Embedded Media",desc:"Insert/Edit Embedded Media"},fullpage:{desc:"Document Properties","delta_width":"","delta_height":""},template:{desc:"Insert Predefined Template Content"},visualchars:{desc:"Show/Hide Visual Control Characters"},spellchecker:{desc:"Toggle Spell Checker",menu:"Spell Checker Settings","ignore_word":"Ignore Word","ignore_words":"Ignore All",langs:"Languages",wait:"Please wait...",sug:"Suggestions","no_sug":"No Suggestions","no_mpell":"No misspellings found.","learn_word":"Learn word"},pagebreak:{desc:"Insert Page Break for Printing"},advlist:{types:"Types",def:"Default","lower_alpha":"Lower Alpha","lower_greek":"Lower Greek","lower_roman":"Lower Roman","upper_alpha":"Upper Alpha","upper_roman":"Upper Roman",circle:"Circle",disc:"Disc",square:"Square"},colors:{"333300":"Dark olive","993300":"Burnt orange","000000":"Black","003300":"Dark green","003366":"Dark azure","000080":"Navy Blue","333399":"Indigo","333333":"Very dark gray","800000":"Maroon",FF6600:"Orange","808000":"Olive","008000":"Green","008080":"Teal","0000FF":"Blue","666699":"Grayish blue","808080":"Gray",FF0000:"Red",FF9900:"Amber","99CC00":"Yellow green","339966":"Sea green","33CCCC":"Turquoise","3366FF":"Royal blue","800080":"Purple","999999":"Medium gray",FF00FF:"Magenta",FFCC00:"Gold",FFFF00:"Yellow","00FF00":"Lime","00FFFF":"Aqua","00CCFF":"Sky blue","993366":"Brown",C0C0C0:"Silver",FF99CC:"Pink",FFCC99:"Peach",FFFF99:"Light yellow",CCFFCC:"Pale green",CCFFFF:"Pale cyan","99CCFF":"Light sky blue",CC99FF:"Plum",FFFFFF:"White"},aria:{"rich_text_area":"Rich Text Area"},wordcount:{words:"Words:"},visualblocks:{desc:'Show/hide block elements'}}});