jinda 0.7.5.2 → 0.7.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +60 -39
- data/lib/generators/jinda/install_generator.rb +6 -4
- data/lib/generators/jinda/templates/app/views/docs/doc_new/doc_form.html.erb +21 -15
- data/lib/generators/jinda/templates/spec/controllers/sessions_controller_spec.rb +7 -5
- data/lib/generators/jinda/templates/spec/features/userlogins_spec.rb +2 -2
- data/lib/generators/jinda/templates/spec/rails_helper.rb +0 -2
- data/lib/generators/jinda/templates/spec/spec_helper.rb +6 -3
- data/lib/generators/jinda/templates/spec/support/databasecleaner.rb +13 -0
- data/lib/jinda/version.rb +1 -1
- metadata +18 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7bf6e82e9caf616289e1439a920f3ac338f5102f048f87bf1df98bd173e7142f
|
|
4
|
+
data.tar.gz: daa518676ade873edb56c5a6b6b3866d834f3574f59a16dfe96c4550f4268291
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0017da27ccf27991a4bcb9c152bf436998ee7f8005bf6b879c31736fa78d8948602e1b7db437e994976b1366d27d75b8ca6d48fa20177c88dc6873116d1a4bc7
|
|
7
|
+
data.tar.gz: 202030be25e6486a77f98aa7782777f6c10e4504d7872d6dec6aee790ef4a62d5542954ed5941a7efe0098ba04518cda748ecf4cb0ad3754431d31ae198fc9ed
|
data/README.md
CHANGED
|
@@ -1,37 +1,62 @@
|
|
|
1
1
|
# Jinda
|
|
2
|
-
Rails Application Generator using Freemind
|
|
3
|
-
* [jinda](https://github.com/kul1/jinda)
|
|
4
|
-
-
|
|
5
2
|
|
|
6
|
-
|
|
7
|
-
|
|
3
|
+
Jinda is a gem to create Rails Workflow & Application Generator using Freemind
|
|
4
|
+
|
|
5
|
+
Jinda is a tools for Ruby on Rails developer. (Required: basic Ruby on Rails )
|
|
6
|
+
|
|
7
|
+
## Jinda use the following technologies:
|
|
8
|
+
|
|
9
|
+
- JQuery Mobile and Bootstrap as Javascript front-end development framework
|
|
10
|
+
- Rails Engine as Jinda core for router, helper
|
|
11
|
+
- Workflow using Freemind design as XML to control Rails flow.
|
|
12
|
+
- User authentication for login and role for each activity
|
|
13
|
+
- Support Social authentication: Facebook, Google
|
|
14
|
+
- Polymorphic Association in mongodb
|
|
15
|
+
- Dynamic role for user and group
|
|
16
|
+
- Rails concern & mixins for rails modules and class
|
|
17
|
+
- Sample app: Articles, API Note, Document
|
|
18
|
+
- Support themes: Jinda_adminlte, Jinda_adminBSB
|
|
19
|
+
- Support HTML, HAML, SCSS
|
|
20
|
+
<br />
|
|
21
|
+
|
|
22
|
+
- [jinda](https://github.com/kul1/jinda) -
|
|
23
|
+
|
|
24
|
+
## Additional Extension themes also available at
|
|
25
|
+
|
|
26
|
+
- [jinda_adminlte](https://github.com/kul1/jinda_adminlte)
|
|
27
|
+
|
|
8
28
|
- 
|
|
9
29
|
|
|
10
|
-
|
|
30
|
+
- [jinda_adminbsb](https://github.com/kul1/jinda_adminbsb)
|
|
11
31
|
- 
|
|
12
32
|
|
|
13
33
|
## Prerequisites
|
|
14
34
|
|
|
15
35
|
These versions works for sure but others may do.
|
|
16
36
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
37
|
+
- Ruby 3.0.0
|
|
38
|
+
- Rails 6.1.3
|
|
39
|
+
- MongoDB 6
|
|
40
|
+
- Freemind 1.0.1
|
|
21
41
|
|
|
22
42
|
## Convention
|
|
23
43
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
44
|
+
- database is MongoDB
|
|
45
|
+
- images stored in upload directory, unset IMAGE_LOCATION in `initializer/jinda.rb` to use Cloudinary
|
|
46
|
+
- mail use Gmail SMTP, config in `config/application.rb`
|
|
47
|
+
- authentication use omniauth-identity
|
|
28
48
|
|
|
29
49
|
## Sample Application
|
|
50
|
+
|
|
30
51
|
### Screen shot install Jinda
|
|
31
|
-
|
|
52
|
+
|
|
53
|
+
[](https://www.youtube.com/watch?v=XUXv7Yrskjk&feature=youtu.be)
|
|
54
|
+
<br />
|
|
55
|
+
[](https://www.youtube.com/watch?v=XUXv7Yrskjk&feature=youtu.be)
|
|
56
|
+
|
|
32
57
|
### Sample Jinda in Docker
|
|
33
58
|
|
|
34
|
-
|
|
59
|
+
- https://github.com/kul1/b-255523-jd
|
|
35
60
|
|
|
36
61
|
Supposed we want to create ecommerce web site, first create a Rails
|
|
37
62
|
app without ActiveRecord
|
|
@@ -74,7 +99,7 @@ now the application is ready, start it as any Rails application
|
|
|
74
99
|
|
|
75
100
|
$ rails server
|
|
76
101
|
|
|
77
|
-
go to http://localhost:3000, click
|
|
102
|
+
go to http://localhost:3000, click _Sign In_ on the left menu, and enter user name `admin` and password `secret`
|
|
78
103
|
|
|
79
104
|
|
|
80
105
|
|
|
@@ -84,9 +109,9 @@ Now open file `app/jinda/index.mm` using Freemind
|
|
|
84
109
|
|
|
85
110
|
The 3 main branches are
|
|
86
111
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
112
|
+
- models - this defines all the models to use in the application
|
|
113
|
+
- 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)
|
|
114
|
+
- roles - this defines role for all users
|
|
90
115
|
|
|
91
116
|
### models
|
|
92
117
|
|
|
@@ -96,12 +121,12 @@ Fiirst, we need to create some product so we click on models we'll see 2 models
|
|
|
96
121
|
|
|
97
122
|
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:
|
|
98
123
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
124
|
+
- `fname` - this create a column (field) called fname which is a String by default
|
|
125
|
+
- `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 Jinda so we can put whatever we want. Here I just put some reminder.
|
|
126
|
+
- `belongs_to :address` - here we have 
|
|
127
|
+
icon. this means whatever text on this line will be added as is to the model Jinda 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>.
|
|
128
|
+
- `dob: date` - use any type that mongoid provides.
|
|
129
|
+
- `photo` - for file field, just use String here. Jinda will receive the binary file and store in file system or cloudinary then generate a url link to it.
|
|
105
130
|
|
|
106
131
|
In this example we just want a product model, so delete the person and address model and add a product branch like so
|
|
107
132
|
|
|
@@ -111,7 +136,7 @@ Save the mind map then run:
|
|
|
111
136
|
|
|
112
137
|
rake jinda:update
|
|
113
138
|
|
|
114
|
-
This will create file `app/models/product.rb`. In this file, note the comment lines
|
|
139
|
+
This will create file `app/models/product.rb`. In this file, note the comment lines `# jinda begin` and ` # jinda end`. Everything inside these comments will get overwritten when you change the models branch in the mind map so if you need to put anything inside here, use the mind map instead. You can add anything outside these comment lines which will be preserved when doing jinda:update.
|
|
115
140
|
|
|
116
141
|
### services
|
|
117
142
|
|
|
@@ -121,34 +146,31 @@ Next we'll add some product into the database, we'll first take a look at the se
|
|
|
121
146
|
|
|
122
147
|
The text `users:User` on the sub branch has these implications:
|
|
123
148
|
|
|
124
|
-
|
|
125
|
-
|
|
149
|
+
- `users` correspond to `app/controllers/users_controller.rb` which already exist when you do rails generate jinda:install. New branch will create new controller if not exist. In Jinda term, this will be called module.
|
|
150
|
+
- `User` will create entry in main menu on the left of the screen. You don't see it in the screenshot above because it's controlled by the sub branch `role:m` which means this menu only available for login member. If you already signed in as admin, you should see it now.
|
|
126
151
|
|
|
127
152
|
The next sub branches has the following:
|
|
128
153
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
154
|
+
- `role: m` - means that this 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.
|
|
155
|
+
- `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 index action of UsersController.
|
|
156
|
+
- `user:edit` the branch that do not start with role:, rule:, nor link: will be a Jinda 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:
|
|
132
157
|
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
158
|
+
- `enter_user:edit` - the first step is to display a form to input user information, this is accompanied by icon 
|
|
159
|
+
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.
|
|
160
|
+
- `update_user` - this icon  means to execute method update_user within `users_controller.rb`
|
|
136
161
|
|
|
137
162
|
Armed with this knowledge, we are ready to add new product into our application like so:
|
|
138
163
|
|
|
139
164
|
|
|
140
165
|
|
|
141
|
-
|
|
142
166
|
To generate controller and views we save this mind map and run
|
|
143
167
|
|
|
144
168
|
rake jinda:update
|
|
145
169
|
|
|
146
170
|
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
|
|
147
171
|
|
|
148
|
-
|
|
149
172
|
|
|
150
173
|
|
|
151
|
-
|
|
152
174
|
Note that we do not specify form_tag and submit_tag, these will be supplied by Jinda.
|
|
153
175
|
|
|
154
176
|
then open file `app/controllers/products_controller.rb` and add `create` method as follow. The method name has to be correspond to the  branch.
|
|
@@ -165,7 +187,6 @@ run following command:
|
|
|
165
187
|
|
|
166
188
|
|
|
167
189
|
|
|
168
|
-
|
|
169
190
|
## Contributing
|
|
170
191
|
|
|
171
192
|
1. Fork it
|
|
@@ -34,15 +34,17 @@ module Jinda
|
|
|
34
34
|
["dotenv-rails"],
|
|
35
35
|
["cloudinary", "1.13.2"],
|
|
36
36
|
["kaminari", "1.2.0"],
|
|
37
|
-
["jquery-rails", "4.3.5"]
|
|
37
|
+
["jquery-rails", "4.3.5"],
|
|
38
|
+
["mongoid"],
|
|
39
|
+
["rexml", "~> 3.2.4"]
|
|
40
|
+
|
|
38
41
|
]
|
|
39
42
|
|
|
40
43
|
jinda_custom =
|
|
41
44
|
[
|
|
42
45
|
["mongoid-paperclip", require: "mongoid_paperclip"],
|
|
43
46
|
["kaminari-mongoid", "1.0.1"],
|
|
44
|
-
["nokogiri", "~> 1.11.0"]
|
|
45
|
-
["mongoid", git: "git@github.com:kul1/mongoid.git"]
|
|
47
|
+
["nokogiri", "~> 1.11.0"]
|
|
46
48
|
]
|
|
47
49
|
|
|
48
50
|
jinda_dev_gem =
|
|
@@ -54,7 +56,7 @@ module Jinda
|
|
|
54
56
|
["binding_of_caller"],
|
|
55
57
|
["pry-byebug"],
|
|
56
58
|
["factory_bot_rails"],
|
|
57
|
-
["database_cleaner"],
|
|
59
|
+
["database_cleaner-mongoid"],
|
|
58
60
|
["guard"],
|
|
59
61
|
["guard-rspec"],
|
|
60
62
|
["guard-minitest"],
|
|
@@ -1,26 +1,32 @@
|
|
|
1
1
|
<%
|
|
2
2
|
doc = Jinda::Doc.new :issue_on=> Date.today, :process_at => Time.now
|
|
3
|
-
%>
|
|
3
|
+
%>
|
|
4
4
|
<%= fields_for doc do |f| %>
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
<div class="form-group">
|
|
6
|
+
<%= f.label :category, "Category" %>
|
|
7
|
+
<%= f.select :category, [["Book", "book"], ["Letter", "letter"], ["Brochure", "brochure"]] %>
|
|
8
|
+
</div>
|
|
9
|
+
<div class="form-group">
|
|
9
10
|
<%= f.label :issue_on, "Dated" %>
|
|
10
11
|
<%= f.date_field :issue_on, "blackDays"=>[0,6] %>
|
|
11
|
-
|
|
12
|
+
</div>
|
|
13
|
+
<div class="form-group">
|
|
12
14
|
<%= f.label :dscan, "Attached document" %>
|
|
15
|
+
</div>
|
|
16
|
+
<div class="form-group">
|
|
13
17
|
<%= f.file_field :dscan %>
|
|
14
|
-
|
|
15
|
-
|
|
18
|
+
</div>
|
|
19
|
+
<% end %>
|
|
20
|
+
<div class="form-group">
|
|
16
21
|
<%= label_tag :description, "Description" %>
|
|
17
22
|
<%= text_field_tag :description %>
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
23
|
+
</div>
|
|
24
|
+
<div class="form-group">
|
|
25
|
+
<%= label_tag :ma_display, "Display", :class=>"ui-input-text" %>
|
|
26
|
+
<%= select_tag :ma_display, options_for_select([['Yes', 'y'], ['No', 'n']],'y'), 'data-role'=>"slider" %>
|
|
27
|
+
</div>
|
|
28
|
+
<div class="form-group">
|
|
29
|
+
<%= label_tag :ma_display, "Display", :class=>"ui-input-text" %>
|
|
24
30
|
<%= label_tag :keywords, "Search Keywords" %>
|
|
25
31
|
<%= text_field_tag :keywords %>
|
|
26
|
-
|
|
32
|
+
</div>
|
|
@@ -22,14 +22,15 @@ describe SessionsController, type: :controller do
|
|
|
22
22
|
session[:user_id].should_not be_nil
|
|
23
23
|
end
|
|
24
24
|
|
|
25
|
-
it "should redirect the user to
|
|
25
|
+
it "should redirect the user to root_path " do
|
|
26
26
|
post :create, params: {provider: :google_oauth2}
|
|
27
|
-
response.should redirect_to
|
|
27
|
+
response.should redirect_to root_path
|
|
28
28
|
end
|
|
29
29
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
|
-
describe "#destroy", js: true do
|
|
32
|
+
#describe "#destroy", js: true do
|
|
33
|
+
describe "#destroy" do
|
|
33
34
|
before do
|
|
34
35
|
post :create, params: {provider: :google_oauth2}
|
|
35
36
|
end
|
|
@@ -49,7 +50,8 @@ describe SessionsController, type: :controller do
|
|
|
49
50
|
end
|
|
50
51
|
end
|
|
51
52
|
|
|
52
|
-
describe "Facebook" do
|
|
53
|
+
skip describe "Facebook" do
|
|
54
|
+
# skip or finish at config facebook
|
|
53
55
|
|
|
54
56
|
before do
|
|
55
57
|
@request.env['omniauth.auth'] = OmniAuth.config.mock_auth[:facebook]
|
|
@@ -71,7 +73,7 @@ describe SessionsController, type: :controller do
|
|
|
71
73
|
|
|
72
74
|
end
|
|
73
75
|
|
|
74
|
-
describe "#destroy"
|
|
76
|
+
describe "#destroy" do
|
|
75
77
|
before do
|
|
76
78
|
post :create, params: {provider: :facebook}
|
|
77
79
|
end
|
|
@@ -2,13 +2,13 @@ require 'rails_helper'
|
|
|
2
2
|
|
|
3
3
|
RSpec.feature "Userlogins", type: :feature do
|
|
4
4
|
scenario "Admin User Sign In" do
|
|
5
|
-
visit "/sessions/new"
|
|
5
|
+
skip visit "/sessions/new"
|
|
6
6
|
|
|
7
7
|
fill_in "User name", :with => "admin"
|
|
8
8
|
fill_in "Password", :with => "secret1"
|
|
9
9
|
click_button "Sign In"
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
xexpect(page).to have_text("My Articles")
|
|
12
12
|
end
|
|
13
13
|
|
|
14
14
|
scenario "Google User Sign In" do
|
|
@@ -6,8 +6,6 @@ Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f } # Add this a
|
|
|
6
6
|
abort("The Rails environment is running in production mode!") if Rails.env.production?
|
|
7
7
|
require 'rspec/rails'
|
|
8
8
|
require 'spec_helper'
|
|
9
|
-
require 'support/factory_bot'
|
|
10
|
-
Dir[Rails.root.join('spec', 'support', '**', '*.rb')].each { |f| require f }
|
|
11
9
|
|
|
12
10
|
RSpec.configure do |config|
|
|
13
11
|
|
|
@@ -8,6 +8,9 @@ require 'valid_attribute'
|
|
|
8
8
|
|
|
9
9
|
# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
|
|
10
10
|
RSpec.configure do |config|
|
|
11
|
+
config.filter_run focus: true
|
|
12
|
+
config.run_all_when_everything_filtered = true
|
|
13
|
+
|
|
11
14
|
# config.include SpecTestHelper, :type => :controller
|
|
12
15
|
config.expect_with :rspec do |expectations|
|
|
13
16
|
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
|
|
@@ -42,12 +45,12 @@ RSpec.configure do |config|
|
|
|
42
45
|
uncommitted transaction data setup over the spec's database connection.
|
|
43
46
|
MSG
|
|
44
47
|
end
|
|
45
|
-
DatabaseCleaner.clean_with(:
|
|
48
|
+
DatabaseCleaner.clean_with(:deletion)
|
|
46
49
|
end
|
|
47
50
|
|
|
48
51
|
config.before(:each, :js => true) do
|
|
49
52
|
#DatabaseCleaner.strategy = :transaction
|
|
50
|
-
DatabaseCleaner.strategy = :
|
|
53
|
+
DatabaseCleaner.strategy = :deletion
|
|
51
54
|
end
|
|
52
55
|
|
|
53
56
|
config.before(:each, type: :feature) do
|
|
@@ -60,7 +63,7 @@ RSpec.configure do |config|
|
|
|
60
63
|
# under test that does *not* share a database connection with the
|
|
61
64
|
# specs, so use truncation strategy.
|
|
62
65
|
# DatabaseCleaner.strategy = :truncation
|
|
63
|
-
DatabaseCleaner[:mongoid].strategy = :
|
|
66
|
+
DatabaseCleaner[:mongoid].strategy = :deletion
|
|
64
67
|
|
|
65
68
|
end
|
|
66
69
|
end
|
data/lib/jinda/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jinda
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.7.
|
|
4
|
+
version: 0.7.6
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Prateep Kul
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: exe
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2021-
|
|
12
|
+
date: 2021-09-05 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: rake
|
|
@@ -59,6 +59,20 @@ dependencies:
|
|
|
59
59
|
- - "~>"
|
|
60
60
|
- !ruby/object:Gem::Version
|
|
61
61
|
version: 7.1.0
|
|
62
|
+
- !ruby/object:Gem::Dependency
|
|
63
|
+
name: rexml
|
|
64
|
+
requirement: !ruby/object:Gem::Requirement
|
|
65
|
+
requirements:
|
|
66
|
+
- - "~>"
|
|
67
|
+
- !ruby/object:Gem::Version
|
|
68
|
+
version: '3.2'
|
|
69
|
+
type: :runtime
|
|
70
|
+
prerelease: false
|
|
71
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - "~>"
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: '3.2'
|
|
62
76
|
description: 'Generate Rails workflow from mind map: Freemind'
|
|
63
77
|
email:
|
|
64
78
|
- 1.0@kul.asia
|
|
@@ -374,6 +388,7 @@ files:
|
|
|
374
388
|
- lib/generators/jinda/templates/spec/rails_helper.rb
|
|
375
389
|
- lib/generators/jinda/templates/spec/spec_helper.rb
|
|
376
390
|
- lib/generators/jinda/templates/spec/support/authentication_helper.rb
|
|
391
|
+
- lib/generators/jinda/templates/spec/support/databasecleaner.rb
|
|
377
392
|
- lib/generators/jinda/templates/spec/support/factory_bot.rb
|
|
378
393
|
- lib/generators/jinda/templates/spec/support/omniauth_macros.rb
|
|
379
394
|
- lib/generators/jinda/templates/spec/support/request_spec_helper.rb
|
|
@@ -473,7 +488,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
473
488
|
- !ruby/object:Gem::Version
|
|
474
489
|
version: '0'
|
|
475
490
|
requirements: []
|
|
476
|
-
rubygems_version: 3.2.
|
|
491
|
+
rubygems_version: 3.2.26
|
|
477
492
|
signing_key:
|
|
478
493
|
specification_version: 4
|
|
479
494
|
summary: 'Rails workflow from mind map: Freemind'
|