Forum: Ruby on Rails Large RoR systems design and implementation

Announcement (2017-05-07): www.ruby-forum.com is now read-only since I unfortunately do not have the time to support and maintain the forum any more. Please see rubyonrails.org/community and ruby-lang.org/en/community for other Rails- und Ruby-related community platforms.
5a49a58c90f15bfada652cb1b2f1131f?d=identicon&s=25 sbrocher (Guest)
on 2009-02-04 04:00
(Received via mailing list)
Hi,

I've implemented a few big RoR apps. I do have some good experience
building large systems in many different languages and platforms but I
don't consider myself a RoR guru, so I'd like you experts comment on
my thoughts.

I'd like to divide a large system (app) into several functional, high-
level sub-systems. These are higher level than rails Models, and
provide APIs that implement business logic around functional groups.
Examples of these are billing manager, security manager (accounts,
privileges, roles, etc), inventory manager, manufacturing manager, and
such (of course, these are just examples, but you get the point).

These high-level sub-systems may be implemented as servers (think
SOAP / REST / XML-RPC / ...), or just plain Ruby classes. Some of
these sub-systems implement integrations with other systems, for
example, a credit card gateway, an accounting system, Fedex, you name
it. Some of the sub-systems may be just proxies to a system
implemented on some other technology.

The user interface (views) would not have access to any of the Models.
They just present and / or grab data that is prepared for them /
pushed back to the controllers as local variables / arrays / hash
tables that don't reflect an actual Model.

The controllers do not have access to Models either. Instead, they
call methods from the high-level functional sub-system APIs.

The Models implement lower-level business logic related to how to the
information is stored and retrieved from the database, the pertinent
validations, associations, etc. but do not implement high-level
business logic such as "how do I bill Joe for a specific event that
results in the combination of many other parameters and variables that
at the end come from diverse fields on many different tables on the
underlying database structure".

The high-level sub-systems all share the same database and therefore
same data model and only communicate with each other via their APIs,
and can access all Models directly.

In other words, this would work more or less as a new layer in between
the MVC pattern:

view <-> controller <-> high-level sub-system <-> models <-> database

The idea is to build the app in a more robust / less coupled way where
I can exchange parts of the app by different technologies and other
applications in the future without having to recode a bunch of things.
For example, the security subsystem could one day be replaced by an
AAA server and then the subsystem would be re-implemented to call the
AAA server (to replace its own original implementation), however the
rest of the app would continue to use the same API calls to the
security subsystem and so the change is isolated from the rest of the
app.

The problem with this is, I'd loose many of the RoR goodness, such as
form helpers, easy models validation thrown back to the interface,
etc.

Am I missing some Ruby language construct or RoR framework construct
that would enable me to implement this kind of design on an easier
manner? Should I instead be thinking of many RoR applications somehow
talking to each other?

I really like RoR but I'm starting to find myself on a tough situation
dealing with evolving mid-to-large systems (think 50+ database tables
and 8+ sub-systems). I need to come up with a pattern that would force
me to implement and design code that works and is maintainable on a
long-term vision, however I'm not sure if this is because I don't know
the 100% of what the language and framework has to offer, or if I am
just using it the wrong way (or both? :-).

Comments?

Thanks,
Seb
3131fcea0a711e5ad89c8d49cc9253b4?d=identicon&s=25 Julian Leviston (Guest)
on 2009-02-04 04:34
(Received via mailing list)
5a49a58c90f15bfada652cb1b2f1131f?d=identicon&s=25 sbrocher (Guest)
on 2009-02-04 19:29
(Received via mailing list)
Hi Julian,

Thanks for your answer. I've seen Datamapper before. However, the way
I understand it, Datamapper is pretty much just a replacement for
ActiveRecord, so I don't see how it would add the extra layer of
abstraction I'm searching for... Did I miss something here?

Thanks
Seb
66dd32f2434b19b052638a478656b81f?d=identicon&s=25 Kim Shrier (Guest)
on 2009-02-04 19:46
(Received via mailing list)
Hello Seb,

An approach that I have used is to place the higher level business
logic in model objects that do not inherit from ActiveRecord.  In
the way I think about larger systems, the higher level business
logic is still part of the model.  The model is not limited to
managing the persistence of state.  I don't have a formal way of
organizing these subsystem model objects as I haven't tackled any
projects that sound as extensive as what you are working on.

HTH
Kim

On Feb 4, 2009, at 11:28 AM, sbrocher wrote:

>
>>
>>> high-
>>> example, a credit card gateway, an accounting system, Fedex, you
>>> The controllers do not have access to Models either. Instead, they
>>> underlying database structure".
>>> database
>>> rest of the app would continue to use the same API calls to the
>>> that would enable me to implement this kind of design on an easier
>>> me to implement and design code that works and is maintainable on a
>> - Show quoted text -
> >
>

--
  Kim Shrier - principal, Shrier and Deihl - mailto:kim@tinker.com
Remote Unix Network Admin, Security, Internet Software Development
   Tinker Internet Services - Superior FreeBSD-based Web Hosting
                      http://www.tinker.com/
A91bd6cef23eb3516245a092e196c4da?d=identicon&s=25 Maurício Linhares (mauricio)
on 2009-02-04 19:49
(Received via mailing list)
A good starting point is read Eric Evan's "Domain Driven Design", you
will probably learn a lot about how to organize big systems in any
language. The book is easy to read and has examples in Java.

-
Maurício Linhares
http://alinhavado.wordpress.com/ (pt-br) | http://blog.codevader.com/
(en)
3131fcea0a711e5ad89c8d49cc9253b4?d=identicon&s=25 Julian Leviston (Guest)
on 2009-02-05 01:35
(Received via mailing list)
The reasons you explained you wanted the layer made me think you only
needed datamapper. Be simpler rather than complex. Explain again why
you need the layer, please? Remember YAGNI.

Blog: http://random8.zenunit.com/
Learn rails: http://sensei.zenunit.com/
5a49a58c90f15bfada652cb1b2f1131f?d=identicon&s=25 sbrocher (Guest)
on 2009-02-05 10:07
(Received via mailing list)
Hi Julian,

No worries. I'm just after the basic high-level design concept where
you first break the (large) problem into several subsystems (i.e.:
divide and conquer). Then define APIs for each subsystem. Then
implement each subsystem. Test each system separately. Integrate. Test
whole system. Also known as the "V" model at another level of
abstraction.

This has many benefits and is a proven technique to design large
systems. It reduces coupling and makes it easier to integrate with
other systems in the future, work with large teams, write more
maintainable code, etc. It also enables you to break down the app onto
different servers in the future as needed, by adding something like
SOAP, REST or XML-RPC in between those APIs.

For example, if a part of the app deals with inventory management, it
will have it's own API. Then if one day I decide to buy an inventory
management system from a vendor that has its own API and similar
features, all I have to do is write a connector (proxy) and place it
inside my app, replacing the inventory management subsystem
implementation by the proxy that communicates back and forth with the
newly acquired system, but without needing to change any of my
interface code, other business logic code, etc.

Seb
3131fcea0a711e5ad89c8d49cc9253b4?d=identicon&s=25 Julian Leviston (Guest)
on 2009-02-05 16:28
(Received via mailing list)
You may be better off using the new engines or merb slices

Blog: http://random8.zenunit.com/
Learn rails: http://sensei.zenunit.com/
This topic is locked and can not be replied to.