mindapp 0.0.2 → 0.0.3

data/README.md

@@ -1,40 +1,160 @@
 # Mindapp
 
-gem to generate ror app from mind map
+I like to develop application using Ruby on Rails. I find that most of my projects has some common tasks such as basic design, user administration, logging, workflow, etc. So I decide to use mind map to act as a language to explain what I want and have the tool generates the application that conform to standard framework so I can then customize everything later on. Mind map is used in design phase where it generates models and controller, in execution phase where it controls the work flow, and also use to generate documentation. System Analyst could use mind map to communicate with technical team to align their requirements and help in development.
 
-## Warning
+## Prerequisites
 
-* under heavy development, not ready yet
+* Ruby 1.9
+* Rails 3.2
+* MongoDB
+* Freemind 0.9
 
 ## Convention
 
 * database is MongoDB
-* images stored in or Cloudinary (default) unset IMAGE_LOCATION in initializer/mindapp.rb to use file system
-* mail use Gmail SMTP
+* images stored in or Cloudinary by default, set IMAGE_LOCATION in `initializer/mindapp.rb` to use file system
+* mail use Gmail SMTP, set up credential in `config/application.rb`
 * authentication use omniauth-identity
+* use Rspec for test
 
 ## Installation
 
+Create Rails app without ActiveRecord
+
+    $ rails new app --skip-test-unit --skip-bundle --skip-active-record
+
 Add this line to your application's Gemfile:
 
     gem 'mindapp'
 
-And then execute:
+you may also need to enable gem `therubyracer` as well, then execute:
 
     $ bundle
 
-Then generate and seed, which will create initial user admin:secret
+Then generate and seed (you will be asked to overwrite `db/seeds.rb`) , which will create initial user admin:secret
 
     $ rails generate mindapp:install
+    $ bundle
     $ rake db:seed
 
-Your app is now ready at http://localhost:3000/. When make changes to app/mindapp/index.mm, run
+Your app is now ready at http://localhost:3000/.
+
+    $ rails server
+
+When make changes to app/mindapp/index.mm, run
 
     $ rake mindapp:update
 
-## Usage
+## Sample Application
+
+Supposed we want to create ecommerce web site
+
+    $ rails new shop --skip-test-unit --skip-bundle --skip-active-record
+
+edit Gemfile:
+
+    gem 'mindapp', :git => "git://github.com/songrit/mindapp.git"
+
+depend on your operating system, you may need to uncomment
+
+    gem 'therubyracer', :platforms => :ruby
+
+install gems
+
+    $ bundle
+
+generate mindapp application
+
+    $ rails generate mindapp:install
+
+it will ask to overwrite the seeds.rb file, enter y, then run bundle again to install additional gems added by mindapp
+
+The next step is create admin user
+
+    $ rake db:seed
+
+now the application is ready, start it as any Rails application
+
+    $ rails server
+
+go to http://localhost:3000, click *Sign In* on the left menu, and enter user name `admin` and password `secret`
+
+![home.mm](http://songrit.googlecode.com/files/home.png)
+
+Now open file `app/mindapp/index.mm` using Freemind
+
+![index.mm](http://songrit.googlecode.com/files/mm.png)
+
+The 3 main branches are
+
+* models - this defines all the models to use in the application
+* services - this defines services which will be come the menu on the left of the screen. There will be 2 levels; the first sub branch is the main menu (modules) and the second sub branch is the sub menu (services)
+* roles - this defines role for all users
+
+### models
+
+Fiirst, we need to create some product so we click on models we'll see 2 models person and address. These are sample only. You can delete them or modify them however you want. We'll take a look at them first
+
+![models](http://songrit.googlecode.com/files/models.png)
+
+The first sub branch (e.g. person) is the model name. According to Rails convention, this should be a singular word. The next sub branch are columns in the database. Let's take a look at each:
+
+* `fname` - this create a column (field) called fname which is a String by default
+* `sex: integer` - this create a column called sex, it is integer so must be explicity defined. The next sub branch (1: male) is disregarded by Mindapp so we can put whatever we want. Here I just put some reminder.
+* `belongs_to :address` - here we have ![edit](http://songrit.googlecode.com/files/edit.png) icon. this means whatever text on this line will be added as is to the model Mindapp generates. You use this to specify anything you want such as  association, index, remarks in code, etc. according to mongoid gem. To draw the icon, rest mouse on the branch and hit <Alt-I>
+* `dob: date` - use any type that mongoid has
+* `photo` - for file field, just use String here. Mindapp will receive the binary file and store in file system or cloudinary then generate a url link to it.
+
+In this example we just want a product model, so delete the person and address model and add a product branch like so
+
+![product](http://songrit.googlecode.com/files/product.png)
+
+Save the mind map then run:
+
+    rake mindapp:update
+
+This will create file `app/models/product.rb`. In this file, note the comment lines   `# mindapp begin` and ` # mindapp end`. Everything inside these comments will get overwritten according to the mind map so if you need to put anything inside here, use the mind map instead. You can add any thing outside these comment lines which will be preserved when doing mindapp:update.
+
+### services
+
+Next we'll add some product into the database, we'll first take a look at the services branch, which already has 3 sub branches; users, admins, and devs. Unlike models person and address, these branches are used by the system so I suggest that you don't delete them. Let's open the users branch
+
+![users](http://songrit.googlecode.com/files/users.png)
+
+The text `users:User` on the sub branch has these implications:
+
+* `users` correspond to `app/controllers/users_controller.rb` which already exist when you do rails generate mindapp:install. New branch will create new controller if not exist. In Mindapp term, this will be called module.
+* `User` will create entry in main menu on the left of the screen
+
+The next sub branch has the following:
+
+* `role: m` - means that this whole module (menu) is available only to user who has role m (if you open the role branch now will see that role m is member). All registered user has role m by default. User who is not log on would not be able to access this module.
+* `link:info: /users` - means that this is a link, the format is link: *submenu label* : *url* where submenu label is the text to show in the submenu and url is the link to go to, in this case, it woud go to http://localhost:3000/users which will perform action index of users_controller.
+* `user:edit` the branch that do not start with role:, rule:, nor link: will be a Mindapp service. You will then specify the sequence of the execution as in this example there are 3 sub branches - enter_user, update_user, and rule:login? Let's take a look at them:
+
+* `enter_user:edit` - the first step is to display a form to input user information, this is accompanied by icon ![attach](http://songrit.googlecode.com/files/attach.png) which means user interface screen. and will correspond to a view file `app/views/users/user/enter_user.html.erb` where `/users` comes from the module name (the sub branch of services), `/user` comes from the service name (the sub branch of users), and `enter_user.html.erb` comes from the first part of this branch. The `edit` after the colon is just a description of this step. This branch also has sub branch `rule:login? && own_xmain?` which specify rule for this step that the user must be login and can continue this task if he is the one who started it. *task* in here means each instance of service.
+* `update_user` - this icon ![bookmark](http://songrit.googlecode.com/files/bookmark.png) means to execute method update_user within `users_controller.rb`
+
+Armed with this knowledge, we are ready to add new product into our application like so:
+
+![products](http://songrit.googlecode.com/files/products.png)
+
+To generate controller and views we save this mind map and run
+
+    rake mindapp:update
+
+open file `app/views/products/add/enter.html.erb` you'll see some sample view already in there but commented. edit the file so it look like this
+
+![enter](http://songrit.googlecode.com/files/enter.png)
+
+Note that we do not specify form_tag and submit_tag, these will be supplied by Mindapp.
+
+then open file `app/controllers/products_controller.rb` and edit to be as follow
+
+![products_controller](http://songrit.googlecode.com/files/products_controller.png)
+
 
-TODO: Write usage instructions here
+... to be continued ...
 
 ## Contributing
 

data/lib/generators/mindapp/install_generator.rb

@@ -79,8 +79,8 @@ DEFAULT_TITLE = 'Mindapp'
 DEFAULT_HEADER = 'Mindapp'
 GMAP = true
 NEXT = "Next >"
-# unset IMAGE_LOCATION to use cloudinary
-# IMAGE_LOCATION = "upload"
+# comment IMAGE_LOCATION to use cloudinary
+IMAGE_LOCATION = "upload"
 # for debugging
 # DONT_SEND_MAIL = true
 }
@@ -127,8 +127,9 @@ end
       def gen_user
         copy_file "seeds.rb","db/seeds.rb"
       end
-      def gen_sample_cloudinary
+      def gen_image_store
         copy_file "cloudinary.yml","config/cloudinary.yml"
+        empty_directory "upload" # create upload directory just in case
       end
     end
   end

data/lib/generators/mindapp/templates/app/controllers/mindapp_controller.rb

@@ -9,6 +9,7 @@ class MindappController < ApplicationController
     @xmains = Mindapp::Xmain.in(status:['E']).desc(:created_at).page(params[:page]).per(10)
   end
   def pending
+    @title= "Pending Tasks"
     @xmains = Mindapp::Xmain.in(status:['R','I']).asc(:created_at)
   end
   def cancel
@@ -255,8 +256,8 @@ class MindappController < ApplicationController
         :display=>true,
         :secured => @xmain.service.secured )
     if defined?(IMAGE_LOCATION)
-      file_name = "#{IMAGE_LOCATION}/f#{Param.gen(:asset_id)}"
-      File.open(file_name,"wb") { |f| f.puts(params.read) }
+      filename = "#{IMAGE_LOCATION}/f#{Param.gen(:asset_id)}"
+      File.open(filename,"wb") { |f| f.puts(params.read) }
       eval "@xvars[@runseq.code][key] = '#{url_for(:action=>'document', :id=>doc.id, :only_path => true )}' "
       doc.update_attributes :url => filename, :basename => File.basename(filename), :cloudinary => false
     else
@@ -276,8 +277,8 @@ class MindappController < ApplicationController
       :data_text=> '',
       :display=>true, :secured => @xmain.service.secured )
     if defined?(IMAGE_LOCATION)
-      file_name = "#{IMAGE_LOCATION}/f#{Param.gen(:asset_id)}"
-      File.open(file_name,"wb") { |f| f.puts(params.read) }
+      filename = "#{IMAGE_LOCATION}/f#{Param.gen(:asset_id)}"
+      File.open(filename,"wb") { |f| f.puts(params.read) }
       eval "@xvars[@runseq.code][key][key1] = '#{url_for(:action=>'document', :id=>doc.id, :only_path => true)}' "
       doc.update_attributes :url => filename, :basename => File.basename(filename), :cloudinary => false
     else
@@ -289,6 +290,7 @@ class MindappController < ApplicationController
   def doc_print
     render :file=>'public/doc.html', :layout=>'layouts/print'
   end
+  # generate documentation for application
   def doc
     require 'rdoc'
     @app= get_app
@@ -316,6 +318,22 @@ class MindappController < ApplicationController
       }
     end
   end
+  # handle uploaded image
+  def document
+    doc = Mindapp::Doc.find params[:id]
+    if doc.cloudinary
+        require 'net/http'
+        require "uri"
+        uri = URI.parse(doc.url)
+        data = Net::HTTP.get_response(uri)
+        # require 'open-uri'
+        # data= open(doc.url)
+        send_data(data.body, :filename=>doc.filename, :type=>doc.content_type, :disposition=>"inline")
+    else
+        data= read_binary(doc.url)
+        send_data(data, :filename=>doc.filename, :type=>doc.content_type, :disposition=>"inline")
+      end
+  end
   def status
     @xmain= Mindapp::Xmain.where(:xid=>params[:xid]).first
     @title= "Task number #{params[:xid]} #{@xmain.name}"
@@ -466,4 +484,7 @@ class MindappController < ApplicationController
     @xmains = GmaXmain.find(@docs.map(&:ma_xmain_id)).sort { |a,b| b.id<=>a.id }
     # @xmains = GmaXmain.find @docs.map(&:created_at).sort { |a,b| b<=>a }
   end
+  def read_binary(path)
+    File.open path, "rb" do |f| f.read end
+  end
 end

data/lib/generators/mindapp/templates/app/controllers/sessions_controller.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 class SessionsController < ApplicationController
   def new
-    @title= 'เข้าใช้ระบบ'
+    @title= 'Sign In'
   end
 
   # to refresh the page, must know BEFOREHAND that the action needs refresh

data/lib/generators/mindapp/templates/app/mindapp/index.mm

@@ -1,8 +1,8 @@
 <map version="0.9.0">
 <!-- To view this file, download free mind mapping software FreeMind from http://freemind.sourceforge.net -->
 <node CREATED="1273819432637" ID="ID_1098419600" MODIFIED="1334737006485" TEXT="Mindapp">
-<node CREATED="1273819462973" ID="ID_282419531" MODIFIED="1334737064016" POSITION="right" TEXT="services">
-<node CREATED="1275756501221" FOLDED="true" ID="ID_1720745721" MODIFIED="1359019893815" TEXT="users:user">
+<node CREATED="1273819462973" ID="ID_282419531" MODIFIED="1360214980377" POSITION="right" TEXT="services">
+<node CREATED="1275756501221" ID="ID_1720745721" MODIFIED="1360217830024" TEXT="users:User">
 <node CREATED="1278491598711" ID="ID_1662699954" MODIFIED="1278491602025" TEXT="role:m"/>
 <node CREATED="1279700865182" ID="ID_1266797279" MODIFIED="1357798847781" TEXT="link:info: /users"/>
 <node CREATED="1319015338880" ID="ID_189841353" MODIFIED="1330477824203" TEXT="link:pending tasks: /mindapp/pending"/>
@@ -14,7 +14,6 @@
 <node CREATED="1275756530989" ID="ID_1221806432" MODIFIED="1282822205361" TEXT="update_user">
 <icon BUILTIN="bookmark"/>
 </node>
-<node CREATED="1276062721100" ID="ID_982357600" MODIFIED="1276062727685" TEXT="rule: login?"/>
 </node>
 <node CREATED="1275756504750" ID="ID_1382277695" MODIFIED="1355422424108" TEXT="pwd:change password">
 <node CREATED="1275756515843" ID="ID_1559014937" MODIFIED="1330477842311" TEXT="enter: edit">
@@ -24,10 +23,9 @@
 <node CREATED="1275756530989" ID="ID_1566171053" MODIFIED="1275756553762" TEXT="change_password">
 <icon BUILTIN="bookmark"/>
 </node>
-<node CREATED="1276062721100" ID="ID_1806588076" MODIFIED="1276062727685" TEXT="rule: login?"/>
 </node>
 </node>
-<node CREATED="1275752678377" FOLDED="true" ID="ID_1348489452" MODIFIED="1359019899148" TEXT="admins:admin">
+<node CREATED="1275752678377" ID="ID_1348489452" MODIFIED="1360217844599" TEXT="admins:Admin">
 <node CREATED="1275752688167" ID="ID_229996461" MODIFIED="1275752690948" TEXT="role:a"/>
 <node CREATED="1282722836614" ID="ID_1213363124" MODIFIED="1330477902602" TEXT="edit_role:edit user role">
 <node CREATED="1282722862918" ID="ID_1190117882" MODIFIED="1330477922159" TEXT="select_user:select user">
@@ -45,17 +43,17 @@
 <node CREATED="1273913393454" ID="ID_1088166839" MODIFIED="1355422465435" TEXT="link: pending tasks: /mindapp/pending"/>
 <node CREATED="1275790679363" ID="ID_829325467" MODIFIED="1355422470135" TEXT="link: logs: /mindapp/logs"/>
 </node>
-<node CREATED="1273706796854" ID="ID_1003882979" MODIFIED="1359019900806" TEXT="devs: developer">
+<node CREATED="1273706796854" ID="ID_1003882979" MODIFIED="1360214993008" TEXT="devs: Developer">
 <node CREATED="1275373154914" ID="ID_340725299" MODIFIED="1275373158632" TEXT="role:d"/>
 <node CREATED="1275788317299" ID="ID_716276608" MODIFIED="1359019912446" TEXT="link: error_logs: /mindapp/error_logs"/>
 </node>
 </node>
-<node CREATED="1273819465949" ID="ID_855471610" MODIFIED="1355422517520" POSITION="right" TEXT="roles">
+<node CREATED="1273819465949" FOLDED="true" ID="ID_855471610" MODIFIED="1360164683130" POSITION="right" TEXT="roles">
 <node CREATED="1273819847470" ID="ID_1681080231" MODIFIED="1330477307826" TEXT="m: member"/>
 <node CREATED="1273819855875" ID="ID_1429503284" MODIFIED="1330477311102" TEXT="a: admin"/>
 <node CREATED="1273819859775" ID="ID_568365839" MODIFIED="1330477315009" TEXT="d: developer"/>
 </node>
-<node CREATED="1273819456867" ID="ID_1677010054" MODIFIED="1334737066801" POSITION="left" TEXT="models">
+<node CREATED="1273819456867" FOLDED="true" ID="ID_1677010054" MODIFIED="1360164679975" POSITION="left" TEXT="models">
 <node CREATED="1292122118499" FOLDED="true" ID="ID_1957754752" MODIFIED="1355422535015" TEXT="person">
 <node CREATED="1292122135809" ID="ID_1617970069" MODIFIED="1332878659106" TEXT="fname"/>
 <node CREATED="1292122150362" ID="ID_1200135538" MODIFIED="1332878662388" TEXT="lname"/>

data/lib/generators/mindapp/templates/app/views/mindapp/_pending_page.haml

@@ -1,4 +1,3 @@
-- @title= "Pending Jobs"
 - @xmains= xmains
 %table{:id=>"pending-table", :width=>"100%"}
   %tr{:style=>"color:white; background-color:#97BF60;"}

data/lib/generators/mindapp/templates/app/views/mindapp/index.html.haml

@@ -4,7 +4,7 @@
 %h2 Requirements
 %ul
   %li Rails 3.2
-  %li Rubygems 1.8.7
+  %li Rubygems 1.8
 
 %h2 Installation
 %ul

data/lib/generators/mindapp/templates/cloudinary.yml

@@ -0,0 +1,9 @@
+development:
+  cloud_name: "sample"
+  api_key: "874837483274837"
+  api_secret: "a676b67565c6767a6767d6767f676fe1"
+
+production:
+  cloud_name: "sample"
+  api_key: "874837483274837"
+  api_secret: "a676b67565c6767a6767d6767f676fe1"

data/lib/generators/mindapp/templates/seeds.rb

@@ -1,4 +1,4 @@
-if Identity.count==0
+unless Identity.where(code:"admin").exists?
   identity= Identity.create :code => "admin", :email => "admin@test.com", :password => "secret",
     :password_confirmation => "secret"
   User.create :provider => "identity", :uid => identity.id.to_s, :code => identity.code,

data/lib/mindapp/version.rb

@@ -1,3 +1,3 @@
 module Mindapp
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mindapp
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-24 00:00:00.000000000 Z
+date: 2013-02-08 00:00:00.000000000 Z
 dependencies: []
 description: generate Ruby on Rails app from mind map
 email:
@@ -222,6 +222,7 @@ files:
 - lib/generators/mindapp/templates/app/views/users/index.haml
 - lib/generators/mindapp/templates/app/views/users/pwd/enter.html.erb
 - lib/generators/mindapp/templates/app/views/users/user/enter_user.html.erb
+- lib/generators/mindapp/templates/cloudinary.yml
 - lib/generators/mindapp/templates/mindapp.yml
 - lib/generators/mindapp/templates/seeds.rb
 - lib/generators/mindapp/templates/spec/controllers/admins_controller_spec.rb