rad_common_interface 0.0.1

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake_ext'
+
+project(
+  name: "common_interface",
+  official_name: "rad_common_interface",
+  gem: true,
+  summary: "User Interface for Rad Framework",
+
+  author: "Alexey Petrushin",
+  homepage: "http://github.com/alexeypetrushin/rad_common_interface"
+)

data/lib/common_interface/gems.rb

@@ -0,0 +1,3 @@
+if respond_to? :fake_gem
+  fake_gem 'rad_face'
+end

data/lib/common_interface/require.rb

@@ -0,0 +1,22 @@
+# Defining custom form tags
+Rad::Face::ThemedFormHelper.generate_form_helper_methods %w(attachments_tag)
+ 
+# Libraries 
+%w(
+  ci_view_helper
+  ci_model_helper
+).each{|f| require "face/#{f}"}
+
+# Helpers
+Rad::Controller::Context.inherit Rad::Face::CiViewHelper
+Rad::Html::ModelHelper.inherit Rad::Face::CiModelHelper
+
+# Demo
+module Rad::Face::Demo
+  autoload :Base,       'face/demo/base'
+  autoload :Helps,      'face/demo/helps'
+  autoload :ViewHelper, 'face/demo/view_helper'
+  autoload :Commons,    'face/demo/commons'
+  autoload :Dialogs,    'face/demo/dialogs'
+  autoload :Sites,      'face/demo/sites'  
+end

data/lib/common_interface/spec.rb

@@ -0,0 +1,27 @@
+require 'rspec_ext'
+
+require 'rad_ext'
+require 'rad/spec'
+require 'rad/spec/xhtml'
+
+rad.common_interface
+
+shared_examples_for 'commons demo' do
+  set_controller Rad::Face::Demo::Commons
+    
+  [:aspects, :basic, :forms, :style, :items].each do |action|    
+    it action do
+      wcall action, theme: @theme
+    end
+  end
+end
+
+shared_examples_for 'site demo' do
+  set_controller Rad::Face::Demo::Sites
+  
+  [:home, :style, :blog, :post].each do |action|
+    it action do
+      wcall action.to_sym, theme: @theme, layout_template: @layouts[action]
+    end
+  end
+end

data/lib/components/common_interface.rb

@@ -0,0 +1,16 @@
+rad.register :common_interface, depends_on: :face do  
+  require 'common_interface/gems'  
+  require 'common_interface/require'
+  
+  # config
+  rad.face.available_themes << :default
+  
+  rad.configure :web, "#{__FILE__}/../../.." do |c|
+    c.locales
+    c.routes
+    c.template_paths 'app/views'
+    c.asset_paths 'app/static'
+  end  
+  
+  true
+end

data/lib/face/ci_model_helper.rb

@@ -0,0 +1,9 @@
+module Rad::Face::CiModelHelper
+  def attachments name, options = {}    
+    render_attribute name, options do |fname, value, o|
+      html = form_helper.hidden_field_tag(fname, '') + "\n"
+      html += form_helper.attachments_tag fname, value, o
+      html
+    end
+  end
+end

data/lib/face/ci_view_helper.rb

@@ -0,0 +1,59 @@
+module Rad::Face::CiViewHelper
+  # 
+  # Form Buttons
+  # 
+  def ok_button text = t(:ok)
+    submit_tag text, class: 'm_submit_form_or_ajax_form'
+  end
+
+  def cancel_button text = t(:cancel)
+    link_to text, :back, class: 'm_redirect_back_or_close_dialog'
+  end
+
+  # 
+  # Custom
+  # 
+  def tag_cloud tags, classes, &block
+    return if tags.empty?
+
+    max_count = tags.sort{|a, b| a.count <=> b.count}.last.count.to_f
+
+    tags.sort{|a, b| a.name <=> b.name}.each do |tag|
+      index = ((tag.count / max_count) * (classes.size - 1)).round
+      block.call tag, classes[index]
+    end
+  end
+  
+  
+  # 
+  # Attachments
+  # 
+  def attachments_tag name, value = [], options = {}
+    value = value.collect{|h| h.to_openobject}
+    render '/face/attachments_tag', object: options.merge(name: name, value: value).to_openobject
+  end
+
+
+  # 
+  # Folder
+  # 
+  # params = {
+  #   l: I18n.locale,
+  # }
+  # 
+  # opt = {
+  #   upload_url: item_files_path(folder),
+  #   view: 'folder_thumb',
+  #   select_files: t(:select_files),
+  # }
+  # def build_files_uploader_for params, opt
+  #   raise 'update me with rad.config and with rad.cookies'
+  #   session_key = ActionController::Base.session_options['key']
+  #   
+  #   params = {
+  #     session_key => cookies[session_key]
+  #   }.merge(params)
+  #   
+  #   "new FilesUpload(#{params.to_json}, #{opt.to_json});"    
+  # end
+end

data/lib/face/demo/base.rb

@@ -0,0 +1,97 @@
+class Rad::Face::Demo::Base
+  inherit Rad::Controller::Http
+  helper Rad::Face::Demo::ViewHelper
+
+  layout '/rad/face/demo/layout'  
+
+  def select_menu
+    workspace.request.session['top_menu'] = params[:top_menu] if params[:top_menu]
+    workspace.request.session['side_menu'] = params[:side_menu] if params[:side_menu]
+
+    redirect_to :back
+  end  
+
+  attr_reader :samples
+
+  # def title
+  #   workspace.method_name.to_s.humanize
+  # end
+  # helper_method :title
+
+  protected        
+    def prepare_theme
+      theme.name = params.theme
+      theme.layout_template = params.layout_template
+    end
+    before :prepare_theme
+
+    def prepare_samples
+      @samples = {
+        title: workspace.method_name.to_s.humanize,
+      
+        top_menu_items: %w(Email Contacts Calendar Files),
+        active_top_menu: (workspace.request.session['top_menu'] || 'Email'),
+
+        side_menu_items: %w(control_caption_0 control_caption_1 control_caption_2),
+        active_side_menu: (workspace.request.session['side_menu'] || 'control_caption_0'),
+
+        tabs: %w(Compose Contacts Import Categories),
+        active_tab: 'Compose',
+
+        name: "Terminator Movie Series",
+        tags: ['egypt', 'photo', 'travel'].collect{|w| "<a href='#'>#{w}</a>"},
+        details: ["Today at 15:58", "by <a href='#'>admin</a>", "{7}"],
+        comment_details: ["Today at 15:58", "by <a href='#'>admin</a>"],
+        controls: %w{add edit delete}.collect{|w| "<a href='#'>#{w}</a>"},
+        
+        attachments: [
+          {
+            name: 'img1', 
+            url: url_for("/static/demo/images/img1.jpg"),
+            icon_url: url_for("/static/demo/images/img1_icon.jpg"),
+            thumb_url: url_for("/static/demo/images/img1_thumb.jpg")
+          }.to_openobject,
+          {
+            name: 'img2',
+            url: url_for("/static/demo/images/img2.jpg"),
+            icon_url: url_for("/static/demo/images/img2_icon.jpg"),
+            thumb_url: url_for("/static/demo/images/img2_thumb.jpg")
+          }.to_openobject,
+          {
+            name: 'img3',
+            url: url_for("/static/demo/images/img3.jpg"),
+            icon_url: url_for("/static/demo/images/img3_icon.jpg"),
+            thumb_url: url_for("/static/demo/images/img3_thumb.jpg")
+          }.to_openobject
+        ],
+      
+        model: {
+          name: "Some Name", 
+          active: true, 
+          body: "Some text",
+        	errors: {
+        		base: ["Base Error Description", "Base Error Description 2"],
+            name: ["Name Error Description 1", "Name Error Description 2"]
+          }
+        },
+
+        detail_text: %(
+<p>The Terminator (1984) <a href='#'>More at IMDbPro</a></p>
+<p>Your future is in his hands.</p>      
+        ),
+
+        text: %(
+<p>The Terminator (1984) <a href='#'>More at IMDbPro</a></p>
+<p>In the Year of Darkness, 2029, the rulers of this planet devised the ultimate plan. They would reshape the Future by changing the Past. The plan required something that felt no pity. No pain. No fear. Something unstoppable. They created 'THE TERMINATOR'</p>
+<p>The thing that won't die, in the nightmare that won't end. A human-looking, apparently unstoppable cyborg is sent from the future to kill Sarah Connor; Kyle Reese is sent to stop it.</p>
+<p>Your future is in his hands.</p>
+        ),
+      
+        comment_text: %(
+<p>Although the Stack Overflow engine was always designed with a technical audience in mind, I'm intrigued to see how far we can push the boundaries of that audience.</p>
+<p>We've pushed a little bit when going from programmers, to sysadmins, to power computer users - and we may try pushing a tad further this year with yet another site.</p>
+        )
+      }.to_openobject
+    end
+    before :prepare_samples
+end

data/lib/face/demo/commons.rb

@@ -0,0 +1,7 @@
+class Rad::Face::Demo::Commons < Rad::Face::Demo::Base
+  def aspects; end      
+  def basic; end      
+  def forms; end  
+  def style; end
+  def items; end
+end

data/lib/face/demo/dialogs.rb

@@ -0,0 +1,23 @@
+class Rad::Face::Demo::Dialogs < Rad::Face::Demo::Base
+  def show; end
+  
+  def dialog_form; end
+  def dialog
+    logger.info "Sleeping for 1 second"
+    sleep 1
+    
+    if params.valid
+      render action: :dialog
+    else
+      render action: :dialog_form
+    end          
+  end
+  
+  def inplace_form; end
+  def inplace
+    logger.info "Sleeping for 1 second"
+    sleep 1
+    
+    @text = params.text
+  end
+end

data/lib/face/demo/helps.rb

@@ -0,0 +1,4 @@
+class Rad::Face::Demo::Helps < Rad::Face::Demo::Base
+  def help; end
+  def index; end
+end

data/lib/face/demo/sites.rb

@@ -0,0 +1,6 @@
+class Rad::Face::Demo::Sites < Rad::Face::Demo::Base
+  def blog; end
+  def home; end      
+  def post; end
+  def style; end
+end

data/lib/face/demo/view_helper.rb

@@ -0,0 +1,29 @@
+module Rad::Face::Demo::ViewHelper
+  def samples
+    @samples
+  end
+
+  def t key, options = {}
+    key.to_s
+  end
+
+  def demo_metadata
+    unless @demo_metadata
+      logger.info "RAD complex calculation :demo_metadata called!"
+      @demo_metadata = {}
+      name = "#{template.directory_name}#{rad.face.themes_path}/#{theme.name}/demo_metadata.rb"
+      if rad.environment.file_exist? name, rad.template.paths
+        fname = rad.environment.find_file! name, rad.template.paths
+        code = File.read fname
+        @demo_metadata = eval code
+        @demo_metadata.must_be.a Hash        
+      end
+      @demo_metadata = @demo_metadata.to_openobject
+    end
+    @demo_metadata
+  end
+  
+  def random_attachment
+    samples.attachments[rand(samples.attachments.size)]
+  end
+end

data/readme.md

@@ -0,0 +1,55 @@
+# Common User Interface for the Rad framework
+
+## Rad Face
+[Rad Face][face] is a tool for **Rapid Web Interface Creation** for the Rad framework.
+
+Instead of trying to provide one universal user interface API (like GWT) to fit all needs, the [Face][face] **provides you with tools that ease creation of your own custom interface**.
+
+Define Your design only one time, in one place, and then reuse it, forget about HTML and CSS in your Views.
+
+It acts like an abstraction layer, allowing you to define your custom API (or DSL if you like) to build your user interface. Key point here - it allows you build such API **very quick and easy**.
+
+## Demo
+
+* [Sample of HomePage][sample1], [sample of page (with another design)][sample2]
+* [List of all Samples][list_of_samples]
+
+Real-life sample - [http://company.4ire.net](http://company.4ire.net), [http://4ire.net](http://4ire.net), there's no any custom template, all pages are made with the [Face][face] plugin.
+
+## Advantages
+
+* **Themes support** not only CSS, you can use completelly different HTML and layouts
+* **DRY**
+* **Clean views**
+* **Iterative development**
+* **Loose coupling of Logic and Design**
+* **Share the same design with many Apps**
+* **Mix two complete different themes** simultaneously, in the same page
+* Start with simple prototype and when App matures create professional design (with minimum changes in App)
+* Theme/Skin support (not only CSS but also Templates, Images, ...)
+* Outsource design without opening App code
+* Designers can go ahead and create working html/css/js
+* Programmers can go ahead and create working App with simple design
+* Both of them can do iterative prototyping that will be updated later
+
+## Usage
+
+	$ sudo gem install common_interface
+
+**Notice!** Default UI is the UI I build for my own need, it's not an universal solution (and maybe you can also use it).
+But to create Your own design you need to create your own 'Default UI', using this code as a sample.
+
+## Development
+
+### Less CSS
+  
+  $ lessc style.less > style.css
+  $ lessc reset.less > reset.css
+
+Copyright (c) Alexey Petrushin [http://4ire.net](http://4ire.net), released under the MIT license.
+
+[face]: http://github.com/alexeypetrushin/face
+
+[sample1]: http://4ire.net/ci_sites/home?layout_template=home&theme=simple_organization
+[sample2]: http://4ire.net/ci_elements/page?theme=default
+[list_of_samples]: http://4ire.net/ci_demo

data/spec/commons_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe "Commons" do
+  before{@theme = 'default'}
+
+  it_should_behave_like "commons demo"
+end

data/spec/helpers_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe "Helpers" do
+  set_controller Rad::Face::Demo::Commons
+  
+  def body
+    wcall(:forms)
+    response.body
+  end
+  
+  it "form_tag should correctly render form (from error)" do
+    body.to_xhtml('#basic_form_tag').should_be_fuzzy_equal_to(
+      id: 'basic_form_tag', action: '/some_action', method: 'post'
+    )
+  end
+  
+  it "form_for should correctly render form (from error)" do
+    body.to_xhtml('#basic_form_for').should_be_fuzzy_equal_to(
+      id: 'basic_form_for', action: '/some_action', method: 'post'
+    )
+  end  
+end

data/spec/helps_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe "Help" do
+  set_controller Rad::Face::Demo::Helps
+  
+  it "should display general help page" do
+    wcall :index
+    response.should be_ok
+  end
+  
+  it "should display theme help" do
+    wcall :help, theme: 'default'
+  end
+end

data/spec/sites_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe "Sites" do
+  before do
+    @theme = 'default'
+    @layouts = {
+      home:  :default, 
+      style: :default, 
+      blog:  :default, 
+      post:  :default
+    }
+  end
+  
+  it_should_behave_like "site demo"
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'common_interface/spec'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: rad_common_interface
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexey Petrushin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-04 00:00:00.000000000 +04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rad_face
+  requirement: &2956880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2956880
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- readme.md
+- lib/common_interface/gems.rb
+- lib/common_interface/require.rb
+- lib/common_interface/spec.rb
+- lib/components/common_interface.rb
+- lib/face/ci_model_helper.rb
+- lib/face/ci_view_helper.rb
+- lib/face/demo/base.rb
+- lib/face/demo/commons.rb
+- lib/face/demo/dialogs.rb
+- lib/face/demo/helps.rb
+- lib/face/demo/sites.rb
+- lib/face/demo/view_helper.rb
+- spec/commons_spec.rb
+- spec/helpers_spec.rb
+- spec/helps_spec.rb
+- spec/sites_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/alexeypetrushin/rad_common_interface
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 3
+summary: User Interface for Rad Framework
+test_files: []