mxit-rails 0.1.2 → 0.1.4

data/README.rdoc

@@ -1,3 +1,102 @@
-= MxitRails
+Mxit Rails
+==========
 
-This project rocks and uses MIT-LICENSE.
+A gem that includes a simple and opinionated templating framework for Rails-based Mxit apps.
+This includes a rough layout, support for styles similar to CSS classes, wrapped inputs, and
+an elegant way to support Mxit's conversation-based interface.
+
+Later versions will also include wrappers for important Mxit APIs.
+
+Sample App
+----------
+A basic to-do app has been set up as an example of the gem in use.  It can be seen at [mxit-to-do](https://github.com/linsen/mxit-to-do).
+
+Installation
+------------
+To use the gem, just include the gem your rails projects' gemfile:
+
+    gem 'mxit-rails', '~> 0.1.2'
+
+The newest version is 0.1.2 - it is not recommended to use any earlier versions.
+
+Basic usage
+-----------
+To set up a controller to use the gem, you need to include the `MxitRails::Page` module:
+
+    include MxitRails::Page
+
+This creates a few helper methods that can be used within that controller
+
+- `input input_name, input_label` - Define the page's input field with a name (symbol) and text label
+- `validate type, [parameter], message` - Set up validations on the input field.
+- `validate message, &block` - A custom message with a block providing a `true` (valid) or `false` (invalid) value.  
+  Note that the block must not use a `return` statement
+- `submit &block` - A code block that will only be executed if the input was submitted and passed all validations.
+
+### Validations
+Currently the following validations are available:
+- `:not_blank`
+- `:numeric`
+- `:length, exact_length`
+- `:min_length, min`
+- `:max_length, max`
+
+
+Multi-step forms
+----------------
+The gem allows the easy set up of multi-step forms within a single controller action.  Forms are defined as follows:
+
+    form do
+      step :first do
+        ...
+      end
+      step :second do
+        ...
+      end
+    end
+
+The order in which steps are defined will be the order they are presented to users in.  Each step should have its own view file, in
+`app/views/controller/action/step`.  Each step has access to the same helper methods as the controller itself.  For steps that don't
+have an input field, a `proceed` helper method is provided
+
+- `proceed message` - Show a proceed link rather than a form input
+
+Users will only proceed to the next step in the form if all validations of the previous step pass.
+
+If the action has a `submit` block (defined outside of the `form`), it will only be executed after the last step is completed.
+
+
+Styles
+------
+Mxit-rails has a basic styling engine that functions similarly to CSS classes.  Styles are identified by a symbol, 
+and can be declared in any controller with the `mxit_style` macro.  It is recommended to declare them in application controller.
+
+    mxit_style :author, 'background-color:#F8F3EA; color:#000000'
+
+To include a style in a template, use the `mxit_style` helper method.  Any number of styles can be given as parameters to this method.
+
+    <p style="<%= mxit_style :author %>">Lewis Carroll</p>
+
+The following special styles are used in the overall layout, and it is thus recommended that they be defined.  Note that links can only be styled per-page, not per link.
+
+- `:body` - The page body (`body` element in html)
+- `:title` - The page title
+- `:link` - The colour of links in the page
+- `:link_hover` - The colour and background colour of highlighted links.
+
+
+Layout
+------
+The gem currently includes a default layout that has a title bar, an optional navigation link, and a form input below the body where appropriate.
+The title and navigation should be defined with `content_for` blocks, addressing `:title` and `:navigation` respectively.
+
+
+Emulator
+--------
+The mxit-rails gem is provided with an emulator to aid development.  It can be accessed at `/emulator`.  The url will dynamically update to show
+the current URL of the page shown as a suffix, e.g. `emulator/path_to/page`.  Certain parts of the app can similarly be loaded directly by
+navigating to their corresponding URL.
+
+To set the root URL of the emulator, add the following line to `config/application.rb`:
+
+    config.mxit_root = 'mxit'

data/lib/mxit_rails/engine.rb

@@ -1,4 +1,7 @@
 module MxitRails
   class Engine < ::Rails::Engine
+    initializer "precompile", :group => :all do |app|
+      app.config.assets.precompile += %w( mxit_rails/emulator.js mxit_rails/emulator.css mxit_rails/included.css )
+    end
   end
 end

data/lib/mxit_rails/version.rb

@@ -1,3 +1,3 @@
 module MxitRails
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/test/dummy/log/development.log

@@ -45411,3 +45411,60 @@ Completed 200 OK in 4ms (Views: 3.6ms | ActiveRecord: 0.0ms)
 
 Started GET "/assets/mxit_rails/included.css?body=1" for 127.0.0.1 at 2012-09-18 08:06:19 +0200
 Served asset /mxit_rails/included.css - 304 Not Modified (0ms)
+
+
+Started GET "/emulator/" for 127.0.0.1 at 2012-09-18 12:11:43 +0200
+Connecting to database specified by database.yml
+Processing by EmulatorController#index as HTML
+  Rendered /Users/linsenloots/Dev/payments/mxit-rails/app/views/emulator/index.html.erb (24.5ms)
+Completed 200 OK in 34ms (Views: 34.1ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/assets/mxit_rails/emulator.css?body=1" for 127.0.0.1 at 2012-09-18 12:11:43 +0200
+Served asset /mxit_rails/emulator.css - 200 OK (2ms)
+
+
+Started GET "/assets/mxit_rails/jquery-1.8.0.min.js?body=1" for 127.0.0.1 at 2012-09-18 12:11:43 +0200
+Served asset /mxit_rails/jquery-1.8.0.min.js - 304 Not Modified (32ms)
+
+
+Started GET "/assets/mxit_rails/jquery.cookie.js?body=1" for 127.0.0.1 at 2012-09-18 12:11:44 +0200
+Served asset /mxit_rails/jquery.cookie.js - 304 Not Modified (3ms)
+
+
+Started GET "/assets/mxit_rails/jquery.history.js?body=1" for 127.0.0.1 at 2012-09-18 12:11:44 +0200
+Served asset /mxit_rails/jquery.history.js - 304 Not Modified (2ms)
+
+
+Started GET "/assets/mxit_rails/emulator.js?body=1" for 127.0.0.1 at 2012-09-18 12:11:44 +0200
+Served asset /mxit_rails/emulator.js - 304 Not Modified (6ms)
+
+
+Started GET "/assets/mxit_rails/nokia-5310-frame.png" for 127.0.0.1 at 2012-09-18 12:11:44 +0200
+Served asset /mxit_rails/nokia-5310-frame.png - 304 Not Modified (12ms)
+
+
+Started GET "/assets/mxit_rails/go.png" for 127.0.0.1 at 2012-09-18 12:11:44 +0200
+Served asset /mxit_rails/go.png - 304 Not Modified (2ms)
+
+
+Started GET "/assets/mxit_rails/out.png" for 127.0.0.1 at 2012-09-18 12:11:44 +0200
+Served asset /mxit_rails/out.png - 304 Not Modified (2ms)
+
+
+Started GET "/assets/mxit_rails/refresh.png" for 127.0.0.1 at 2012-09-18 12:11:44 +0200
+Served asset /mxit_rails/refresh.png - 304 Not Modified (2ms)
+
+
+Started GET "/mxit" for 127.0.0.1 at 2012-09-18 12:11:44 +0200
+Processing by IndexController#index as HTML
+  Rendered index/index.html.erb within layouts/mxit (0.6ms)
+Completed 200 OK in 10ms (Views: 9.5ms | ActiveRecord: 0.0ms)
+
+
+Started GET "/assets/mxit_rails/included.css?body=1" for 127.0.0.1 at 2012-09-18 12:11:44 +0200
+Served asset /mxit_rails/included.css - 200 OK (3ms)
+
+
+Started GET "/assets/mxit_rails/favicon.ico" for 127.0.0.1 at 2012-09-18 12:11:44 +0200
+Served asset /mxit_rails/favicon.ico - 304 Not Modified (3ms)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxit-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors: